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

670 HP C SIP Stack Message Layer Reference Guide
Control Functions
RvSipRouteHopHeaderEncode()
RvSipRouteHopHeaderEncode()
DESCRIPTION
Encodes a Route-Hop header to a textual Route or Record-Route header. The
textual header is placed on a page taken from a specified pool. To copy the
textual header from the page to a consecutive buffer, use
RPOOL_CopyToExternal().
SYNTAX
RvStatus RvSipRouteHopHeaderEncode(
IN RvSipRouteHopHeaderHandle hHeader,
IN HRPOOL hPool,
OUT HPAGE* hPage,
OUT RvUint32* length);
PARAMETERS
hHeader
The handle to the Route-Hop header.
hPool
The handle to the specified memory pool.
hPage
The memory page allocated to contain the encoded header.
length
The length of the encoded information.
RETURN VALUES
Returns RvStatus.