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

Message Object Functions 11
Control Functions
RvSipMsgForceCompactForm()
RvSipMsgForceCompactForm()
DESCRIPTION
Instructs a message to force all its headers to use compact form. If compact form
is forced and a message is encoded, all headers that can take compact form will
be encoded with compact form. Headers that are handled by the Stack as Other
headers and are added to the message by the application will not use compact
form. It is the responsibility of the application to set such header names with
compact form. Other headers that are added to the message by the Stack, such as
supported headers, will be encoded with compact form.
SYNTAX
RvStatus RvSipMsgForceCompactForm(
IN RvSipMsgHandle hSipMsg,
IN RvBool bForceCompactForm)
PARAMETERS
hSipMsg
The handle to the message.
bForceCompactForm
Specifies whether or not to force compact form.
REMARKS
This flag effects only the encoding results of full messages. If
you retrieve a specific header from the message and encode it,
it will not be encoded with compact form if this specific header
is not marked with compact form.
The address header list and headers in a multipart mime bodies
are not effected by this flag and will not be encoded with
compact form.
RETURN VALUES
Returns RvStatus.