HP-UX C SIP Stack Message Layer Reference Guide (February 2008)

744 HP C SIP Stack Message Layer Reference Guide
Get and Set Functions
RvSipSubscriptionStateHeaderSetSubstate()
RvSipSubscriptionStateHeaderSetSubstate()
DESCRIPTION
Sets the substate parameter in the Subscription-State header. If the enumeration
given by eSubstate is RVSIP_SUBSCRIPTION_SUBSTATE_OTHER, sets the
substate string given by strSubstate in the Subscription-State header. Use
RVSIP_SUBSCRIPTION_SUBSTATE_OTHER when the substate you wish to
set to the Subscription-State header does not have a matching enumeration value
in the RvSipSubscriptionSubstate enumeration.
SYNTAX
RvStatus RvSipSubscriptionStateHeaderSetSubstate(
IN RvSipSubscriptionStateHeaderHandle hHeader,
IN RvSipSubscriptionSubstate eSubstate,
IN RvChar *strSubstate);
PARAMETERS
hHeader
The handle to the Subscription-State header.
eSubstate
The substate enumeration to be set in the Subscription-State header. If
RVSIP_SUBSCRIPTION_SUBSTATE_UNDEFINED is supplied, the existing
substate is removed from the header.
strSubstate
The substate string to be set in the Subscription-State header.
(Relevant when eSubstate is RVSIP_SUBSCRIPTION_SUBSTATE_OTHER.)
RETURN VALUES
Returns RvStatus.