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

620 HP C SIP Stack Message Layer Reference Guide
Control Functions
RvSipReferredByHeaderParseValue()
RvSipReferredByHeaderParseValue()
DESCRIPTION
Parses a SIP textual Referred-By header value into an Referred-By header. A
SIP header has the following grammar: “header-name:header-value”. This
function takes the header-value part as a parameter and parses it into the
supplied object. All the textual parameters are placed inside the object.
Note Before performing the parse operation, the SIP Stack resets all the header
parameters. Therefore, if the parse function fails, you will not be able to get the
previous header parameter values.
Note Use the RvSipReferredByHeaderParse() function to parse strings that also
include the header-name.
SYNTAX
RvStatus RvSipReferredByHeaderParseValue(
IN RvSipReferredByHeaderHandle hHeader,
IN RvChar* buffer);
PARAMETERS
hHeader
The handle to the Referred-By header.
buffer
The buffer containing a textual Referred-By header value.
RETURN VALUES
Returns RvStatus.