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

Subscription-State Header Functions 747
Get and Set Functions
RvSipSubscriptionStateHeaderSetReason()
RvSipSubscriptionStateHeaderSetReason()
DESCRIPTION
Sets the reason parameter in the Subscription-State header. If the enumeration
given by eReason is RVSIP_SUBSCRIPTION_REASON_OTHER, sets the
reason string given by strReason in the Subscription-State header. Use
RVSIP_SUBSCRIPTION_REASON_OTHER when the substate you wish to
set to the Subscription-State header does not have a matching enumeration value
in the RvSipSubscriptionReason enumeration.
SYNTAX
RvStatus RvSipSubscriptionStateHeaderSetReason(
IN RvSipSubscriptionStateHeaderHandle hHeader,
IN RvSipSubscriptionReason eReason,
IN RvChar *strReason);
PARAMETERS
hHeader
The handle to the Subscription-State header.
eReason
The reason enumeration to be set in the Subscription-State header. If
RVSIP_SUBSCRIPTION_REASON_UNDEFINED is supplied, the existing
reason is removed from the header.
strReason
The reason string to be set in the Subscription-State header.
(Relevant when eReason is RVSIP_SUBSCRIPTION_REASON_OTHER.)
RETURN VALUES
Returns RvStatus.