Manual Pages for UNIX Operating System command usage for man sip_delete_header_by_name

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 

     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  speci-
     fied 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.





SunOS 5.11          Last change: 20 Jan 2007                    1






Session Initiation Protocol Library Functions
                                      sip_delete_start_line(3SIP)



     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  follow-
     ing:

     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  attri-
     butes:



     ____________________________________________________________
    |       ATTRIBUTE TYPE        |       ATTRIBUTE VALUE       |
    |_____________________________|_____________________________|
    | Interface Stability         | Committed                   |
    |_____________________________|_____________________________|
    | MT-Level                    | MT-Safe                     |
    |_____________________________|_____________________________|


SEE ALSO
     libsip(3LIB)


















SunOS 5.11          Last change: 20 Jan 2007                    2






Session Initiation Protocol Library Functions
                                      sip_delete_start_line(3SIP)






















































SunOS 5.11          Last change: 20 Jan 2007                    3