sip_copy_start_line(3sip) [opensolaris man page]

sip_copy_start_line(3SIP)			   Session Initiation Protocol Library Functions			 sip_copy_start_line(3SIP)

NAME

       sip_copy_start_line, sip_copy_header, sip_copy_header_by_name, sip_copy_all_headers - copy headers from a SIP message

SYNOPSIS

       cc [ flag ... ] file ... -lsip [ library ... ]
       #include <sip.h>

       int sip_copy_start_line(sip_msg_t from_msg, sip_msg_t to_msg);

       int sip_copy_header(sip_msg_t sip_msg, sip_header_t sip_header,
	    char *param);

       int sip_copy_header_by_name(sip_msg_t from_msg, sip_msg_t to_msg,
	    char *header_name, char *param);

       int sip_copy_all_headers(sip_msg_t from_msg, sip_msg_t to_msg);

DESCRIPTION

       The sip_copy_start_line() function copies the start line, a request or a response line, from from_msg to to_msg.

       The  sip_copy_header()  function copies the SIP header specified by sip_header to the SIP message sip_msg. A new SIP header is created from
       sip_header and param, and is appended to sip_msg. The param can be non-null.

       The sip_copy_header_by_name() function copies the header specified by header_name (long or short form) from from_msg  to  to_msg.  The  new
       header is created using the header value from from_msg and param, if non-null, and appended to to_msg.

       The sip_copy_all_headers() copies all the headers from from_msg to to_msg.

RETURN VALUES

       These functions return 0 on success and the appropriate error on failure.

       The value of errno is not changed by these calls in the event of an error.

ERRORS

       These functions can return one of the following errors in case of failure:

       EINVAL	 If the required input parameters are NULL or if the header being copied does not exist or is deleted in source SIP message.

       ENOMEM	 Error while allocating memory for creating the new header.

       EPERM	 If the input SIP message cannot be modified.

ATTRIBUTES

       See attributes(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |Interface Stability	     |Committed 		   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |MT-Safe			   |
       +-----------------------------+-----------------------------+

SEE ALSO

       libsip(3LIB)

SunOS 5.11							    25 Jan 2007 					 sip_copy_start_line(3SIP)

sip_msg_to_str(3SIP)				   Session Initiation Protocol Library Functions			      sip_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 respon-
       sible 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
       responsible 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 ALSO

       libsip(3LIB)

SunOS 5.11							    25 Jan 2007 					      sip_msg_to_str(3SIP)