MyWebUniversity.com Home Page
 



OpenSolaris man pages main menu


Session Initiation Protocol Library Functions
                                        sipgetparamvalue(3SIP)



NAME
     sipgetparamvalue, sipgetparams, sipisparampresent  -
     get parameter information for a SIP header value

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

     const sipstrt *sipgetparamvalue
          (sipheadervaluet headervalue, char *paramname, int *error);


     const sipparamt *sipgetparams
          (sipheadervaluet headervalue, int *error);;


     booleant sipisparampresent
          (const sipparamt *paramlist, char *paramname, int paramlen);


DESCRIPTION
     The sipgetparamvalue() function returns the value for the
     parameter  name  specified by paramname from the SIP header
     value headervalue.


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

       typedef struct sipstr {
            char *sipstrptr;
            int  sipstrlen;
       }sipstrt;



     The  sipstrptr  parameter  points  to  the  start  of  the
     returned  value  and  sipstrlen supplies the length of the
     returned value.


     The sipgetparams() function returns the parameter list, if
     any, for the SIP header value headervalue.


     The sipisparampresent() function returns  BTRUE  if  the
     parameter  specified  by  paramname  of  length supplied in
     paramlen is present in the parameter list, paramlist. Oth-
     erwise, it returns BFALSE.





SunOS 5.11          Last change: 25 Jan 2007                    1






Session Initiation Protocol Library Functions
                                        sipgetparamvalue(3SIP)



RETURN VALUES
     With the exception of  sipisparampresent(),  these  func-
     tions  return  the  queried  value  on  success  and NUL on
     failure.


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

ERORS
     If the error is non-null, one of  the  following  values  is
     set:

     EINVAL    If any of the required input is  NUL  or  if  the
               specified SIP header value is marked deleted.


     EPROTO    If the returned SIP header value is invalid  (i.e.
               the  parser  encountered  errors  when parsing the
               value).



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

ATRIBUTES
     See attributes(5) for descriptions of the  following  attri-
     butes:



     
           ATRIBUTE TYPE               ATRIBUTE 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
                                        sipgetparamvalue(3SIP)






















































SunOS 5.11          Last change: 25 Jan 2007                    3






OpenSolaris man pages main menu

Contact us      |       About us      |       Term of use      |       Copyright © 2000-2010 MyWebUniversity.com ™