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

222 HP C SIP Stack Message Layer Reference Guide
Get and Set Functions
RvSipAuthenticationHeaderGetStrBadSyntax()
RvSipAuthenticationHeaderGetStrBadSyntax()
DESCRIPTION
Copies the bad-syntax string from the header into a given buffer. A SIP header
has the following grammar: “header-name:header-value”. When a header
contains a syntax error, the header-value is kept as a separate bad-syntax string.
You use this function to retrieve the bad-syntax string.
If the value of bufferLen is adequate, this function copies the requested
parameter into strBuffer. Otherwise, the function returns
RV_ERROR_INSUFFICIENT_BUFFER and actualLen contains the required
buffer length. Use this function in the RvSipTransportBadSyntaxMsgEv()
callback implementation if the message contains a bad Authentication header,
and you wish to see the header-value.
SYNTAX
RvStatus RvSipAuthenticationHeaderGetStrBadSyntax(
IN RvSipAuthenticationHeaderHandle hHeader,
IN RvChar* strBuffer,
IN RvUint bufferLen,
OUT RvUint* actualLen);
PARAMETERS
hHeader
The handle to the header.
strBuffer
The buffer with which to fill the bad-syntax string.
bufferLen
The length of the buffer.
actualLen
The length of the bad-syntax string + 1, to include a NULL value at the end of
the parameter.