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

Message Object Functions 27
Get and Set Functions
RvSipMsgGetHeaderByType()
RvSipMsgGetHeaderByType()
DESCRIPTION
Gets a header by type from the header list. The message holds most headers in a
sequential list except, To, From, CallId, Cseq, ContentLength and Content-Type
headers. The function returns the handle to the requested header as a void
pointer. You should cast the return value to the header type you requested.
Note The RvSipMsgGetHeaderByTypeExt() function is an extension of this
function.
SYNTAX
void* RvSipMsgGetHeaderByType(
IN RvSipMsgHandle hSipMsg,
IN RvSipHeaderType eHeaderType,
IN RvSipHeadersLocation location,
INOUT RvSipHeaderListElemHandle* hListElem);
PARAMETERS
hSipMsg
The handle to the message.
eHeaderType
The header type to be retrieved.
location
The location in the header list: next, previous, first or last.
hListElem
The handle to the current position in the list. Supply this value if you chose next
or previous in the location parameter. This is also an output parameter and will
be set with a link to requested header in the list.