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

264 HP C SIP Stack Message Layer Reference Guide
Control Functions
RvSipAuthorizationHeaderEncode()
RvSipAuthorizationHeaderEncode()
DESCRIPTION
Encodes an Authorization header to a textual Authorization 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 RvSipAuthorizationHeaderEncode(
IN RvSipAuthorizationHeaderHandle hHeader,
IN HRPOOL hPool,
OUT HPAGE* hPage,
OUT RvUint32* length);
PARAMETERS
hHeader
The handle to the Authorization 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.
REMARKS
The application must free the allocated page, using RPOOL_FreePage(). The
allocated page must be freed only if this function returns RV_OK.