opensolaris man page for sip_get_param_value

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

NAME
       sip_get_param_value, sip_get_params, sip_is_param_present - get parameter information for a SIP header value

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

       const sip_str_t *sip_get_param_value
	    (sip_header_value_t header_value, char *param_name, int *error);

       const sip_param_t *sip_get_params
	    (sip_header_value_t header_value, int *error);;

       boolean_t sip_is_param_present
	    (const sip_param_t *param_list, char *param_name, int param_len);

DESCRIPTION
       The sip_get_param_value() function returns the value for the parameter name specified by param_name from the SIP header value header_value.

       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.

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

       The  sip_is_param_present()  function returns B_TRUE if the parameter specified by param_name of length supplied in param_len is present in
       the parameter list, param_list. Otherwise, it returns B_FALSE.

RETURN VALUES
       With the exception of sip_is_param_present(), these functions return the queried value on success and NULL on failure.

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

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

       EINVAL	 If any of the required input is NULL 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.

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_get_param_value(3SIP)