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

672 HP C SIP Stack Message Layer Reference Guide
Control Functions
RvSipRouteHopHeaderParseValue()
RvSipRouteHopHeaderParseValue()
DESCRIPTION
Parses a SIP textual Route-Hop header value into a Route-Hop 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 RvSipRouteHopHeaderParse() function to parse strings that also
include the header-name.
SYNTAX
RvStatus RvSipRouteHopHeaderParseValue(
IN RvSipRouteHopHeaderHandle hHeader,
IN RvChar* buffer);
PARAMETERS
hHeader
The handle to the Route-Hop header.
buffer
The buffer containing a textual Route-Hop header value.
RETURN VALUES
Returns RvStatus.