Manual Pages for UNIX Operating System command usage for man sip_free_parsed_uri

Session Initiation Protocol Library Functions
                                              sip_parse_uri(3SIP)



NAME
     sip_parse_uri, sip_free_parsed_uri - parse a URI and free  a
     parsed URI

SYNOPSIS
     cc [ flag ... ] file ... -lsip [ library ... ]
     #include 

     sip_uri_t sip_parse_uri(sip_str_t *uri_str,
          int *error);


     void sip_free_parsed_uri(sip_uri_t sip_uri);


DESCRIPTION
     For functions that  return  a  pointer  of  type  sip_str_t,
     sip_str_t is supplied by:

       typedef struct sip_str {
            char *sip_str_ptr;
            int  sip_str_len;
       }sip_str_t;



     The  sip_str_ptr  parameter  points  to  the  start  of  the
     returned  value  and  sip_str_len supplies the length of the
     returned value.


     For example, given the following request line in a SIP  mes-
     sage input to sip_get_request_uri_str():

       INVITE sip:marconi@radio.org SIP/2.0



     the return is a pointer to sip_str_t  with  the  sip_str_ptr
     member   pointing   to   "s"  of  sip:marconi@radio.org  and
     sip_str_len   being   set   to    21,    the    length    of
     sip:marconi@radio.org.


     The sip_parse_uri() function takes a URI string in the  form
     sip_str_t  and  returns  a parsed URI sip_uri. The syntax of
     the URI is as specified in RFC 3261, section  25.1.  If  the
     parser encounters an error when parsing a component, it sets
     the appropriate error bit in the error flags and proceeds to
     the next component, if present.




SunOS 5.11          Last change: 25 Jan 2007                    1






Session Initiation Protocol Library Functions
                                              sip_parse_uri(3SIP)



     The  sip_free_parsed_uri()  function  takes  a  parsed   URI
     sip_uri,  obtained from sip_parse_uri(), and frees any asso-
     ciated memory.

RETURN VALUES
     The sip_parse_uri() function returns the parsed URI  sip_uri
     on  success. It returns a NULL if memory cannot be allocated
     for the parsed URI.


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

ERRORS
     If the error is non-null, the following values is set:

     EINVAL    The SIP header value of the SIP message is NULL or
               there is no URI.

               The input URI is null or the  requested  URI  com-
               ponent  is  invalid. The error flag is set for the
               requested component.

               The URI parameters or headers are requested from a
               non-SIP[S]  URI; or the 'opaque', 'query', 'path',
               'reg-name' components are requested from a  SIP[S]
               URI.



     On success, the value of the location pointed to by error is
     set to 0.

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: 25 Jan 2007                    2






Session Initiation Protocol Library Functions
                                              sip_parse_uri(3SIP)






















































SunOS 5.11          Last change: 25 Jan 2007                    3