sip_get_header(3sip) [opensolaris man page]

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

NAME

       sip_get_header - get a SIP header from a message

SYNOPSIS

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

       const struct sip_header *sip_get_header(sip_msg_t sip_msg,
	    char *header_name, sip_header_t old_header, int *error);

DESCRIPTION

       The  sip_get_header()  function	returns  the  header  specified  by  header_name  (long  or compact form) from the SIP message sip_msg. If
       header_name is NULL, the first header in the SIP message is returned. The old_header, if  non-null,  specifies  the  starting  position	in
       sip_msg	from  which the search is started. Otherwise, the search begins at the start of the SIP message. For example, to get the first VIA
       header from the SIP message sip_msg:

	 via_hdr = sip_get_header(sip_msg, "VIA", NULL, &error);

       To get the next VIA header from sip_msg:

	 via_hdr = sip_get_header(sip_msg, "VIA", via_hdr, &error);

       The sip_get_header() function ignores any header that is marked as deleted.

RETURN VALUES

       On success, the sip_get_header() function returns the queried header. On failure, it returns NULL.

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

ERRORS

       The following value may be returned:

       EINVAL	 The header_name specified in the SIP message is not present or has been deleted; or, the header_name is not specified	and  there
		 are no "un-deleted" headers in the SIP message.

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							    09 Feb 2007 					      sip_get_header(3SIP)

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)