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

Subscription-State Header Functions 743
Get and Set Functions
RvSipSubscriptionStateHeaderGetStrSubstate()
RvSipSubscriptionStateHeaderGetStrSubstate()
DESCRIPTION
Copies the substate string from the Subscription-State header into a given buffer.
Use this function when the substate enumeration returned by
RvSipSubscriptionStateHeaderGetSubstate() is
RVSIP_SUBSCRIPTION_SUBSTATE_OTHER. If bufferLen is adequate, the
function copies the requested parameter into strBuffer. Otherwise, the function
returns RV_ERROR_INSUFFICIENT_BUFFER and actualLen contains the
required buffer length.
SYNTAX
RvStatus RvSipSubscriptionStateHeaderGetStrSubstate(
IN RvSipSubscriptionStateHeaderHandle hHeader,
IN RvChar* strBuffer,
IN RvUint bufferLen,
OUT RvUint* actualLen);
PARAMETERS
hHeader
The handle to the header.
strBuffer
The buffer to fill with the requested parameter.
bufferLen
The length of the buffer.
actualLen
The length of the requested parameter + 1, to include a NULL value at the end
of the parameter.
RETURN VALUES
Returns RvStatus.