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

8 HP C SIP Stack Message Layer Reference Guide
Control Functions
RvSipMsgEncode()
RvSipMsgEncode()
DESCRIPTION
Encodes a message to a textual SIP message. The textual SIP message is placed
on a page taken from a given memory pool. To copy the message from the page
to a consecutive buffer, use RPOOL_CopyToExternal().
SYNTAX
RvStatus RvSipMsgEncode(
IN RvSipMsgHandle hSipMsg,
IN HRPOOL hPool,
OUT HPAGE* hPage,
OUT RvUint32* length);
PARAMETERS
hSipMsg
The handle to the message to encode.
hPool
The handle to a pool.
hPage
The memory page allocated to hold the encoded message.
length
The length of the encoded message.
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.