Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

sip_delete_value(3sip) [opensolaris man page]

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

NAME

       sip_delete_start_line, sip_delete_header, sip_delete_header_by_name, sip_delete_value - delete a SIP header or a header value

SYNOPSIS

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

       int sip_delete_start_line(sip_msg_t sip_msg);

       int sip_delete_header(sip_msg_t sip_header);

       int sip_delete_header_by_name(sip_msg_t msg,
	    char *header_name);

       int sip_delete_value(sip_header_t sip_header,
	    sip_header_value_t sip_header_value);

DESCRIPTION

       The sip_delete_start_line() function deletes the start line, a request or a response line, from the SIP message sip_msg.

       The sip_delete_header() function deletes the SIP header specified by sip_header from the associated SIP message sip_msg.

       The  sip_delete_header_by_name()  function deletes the SIP header name specified by header_name (long or compact form) from the SIP message
       sip_msg.

       The sip_delete_value() deletes the SIP header value specified by sip_header_value from the SIP header sip_header.

       When a SIP header or value is deleted, the corresponding header or value is marked as deleted.  Lookups ignore headers or values  that  are
       marked as deleted.

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

       On failure, the returned error could be one of the following:

       EINVAL	 If any of the required input is NULL.

		 If the header or value to be deleted does not exist.

		 If the header or value to be deleted has already been deleted.

       EPERM	 If the 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							    20 Jan 2007 				       sip_delete_start_line(3SIP)

Check Out this Related Man Page

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

NAME

       sip_add_param - add a parameter to the SIP header

SYNOPSIS

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

       sip_header_t sip_add_param(sip_header_t sip_header, char *param,
	    int *error);

DESCRIPTION

       The  sip_add_param()  function  adds the parameter provided in param to the SIP header sip_header. The function returns the header with the
       parameter added. A new header is created as a result of adding the parameter and the old header is marked deleted. Applications with multi-
       ple  threads  working  on the same SIP header need to take note of this. If error is non-null, it (the location pointer by the variable) is
       set to 0 on success and the appropriate error value on error.

RETURN VALUES

       The sip_add_param() function returns the new header on success and null on failure. Further, if error is  non-null,  then  on  success  the
       value in the location pointed by error is 0 and the appropriate error value on failure.

ERRORS

       On failure, functions that return an error value may return one of the following:

       EINVAL	 Mandatory parameters are not provided, i.e. null.

		 For sip_add_param(), the header to be modified is marked deleted.

       EPERM	 The message cannot be modified.

       ENOMEM	 There is an error allocating memory for creating headers/parameters.

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_add_param(3SIP)
Man Page