sip_msg_to_str(3SSession Initiation Protocol Library Functsip_msg_to_str(3SIP)NAME
sip_msg_to_str, sip_hdr_to_str, sip_reqline_to_str,
sip_respline_to_str, sip_sent_by_to_str - return string representations
SYNOPSIS
cc [ flag ... ] file ... -lsip [ library ... ]
#include <sip.h>
char *sip_msg_to_str(sip_msg_t sip_msg,
int *error);
char *sip_hdr_to_str(sip_header_t sip_header,
int *error);
char *sip_reqline_to_str(sip_msg_t sip_msg,
int *error);
char *sip_respline_to_str(sip_msg_t sip_msg,
int *error);
char *sip_sent_by_to_str(int *error);
DESCRIPTION
The sip_msg_to_str() function returns the string representation of the
SIP message sip_msg. Deleted headers are not included in the returned
string. The caller is responsible for freeing the returned string.
The sip_hdr_to_str() function returns the string representation of the
SIP header sip_header. The caller is responsible for freeing the
returned string.
The sip_reqline_to_str() function returns the string representation of
the request line from the SIP message sip_msg. The caller is responsi‐
ble for freeing the returned string.
The sip_respline_to_str() function returns the string representation of
the response line from the SIP message sip_msg. The caller is responsi‐
ble for freeing the returned string.
The sip_sent_by_to_str() function can be used to retrieve the list of
sent-by values registered with the stack. The returned string is a
comma separated list of sent-by values. The caller is responsible for
freeing the returned string.
RETURN VALUES
The sip_msg_to_str(), sip_hdr_to_str(), sip_reqline_to_str(),
sip_respline_to_str(), and sip_sent_by_to_str() functions return the
relevant string on success and NULL on failure.
The value of errno is not changed by these calls in the event of an
error.
ERRORS
For the sip_msg_to_str(), sip_hdr_to_str(), sip_reqline_to_str(), and
sip_respline_to_str(), one of the following values is set if the error
is non-null:
EINVAL Input is null.
ENOMEM Memory allocation failure.
On success, the value of the location pointed to by error is set to 0.
ATTRIBUTES
See attributes(5) for descriptions of the following attributes:
┌─────────────────────────────┬─────────────────────────────┐
│ ATTRIBUTE TYPE │ ATTRIBUTE VALUE │
├─────────────────────────────┼─────────────────────────────┤
│Interface Stability │Committed │
├─────────────────────────────┼─────────────────────────────┤
│MT-Level │MT-Safe │
└─────────────────────────────┴─────────────────────────────┘
SEE ALSOlibsip(3LIB)SunOS 5.11 25 Jan 2007 sip_msg_to_str(3SIP)