SIP API Developer's Guide

Value Retrieval and Response Description Functions

const struct sip_value *sip_get_header_value(const struct sip_header *sip_header, int *error);

The *sip_get_header_value() function returns the parsed value for the header that is specified by the value of the sip_header parameter. This function does not return any values that are marked as deleted.

const struct sip_value *sip_get_next_value(sip_header_value_t old_value, int *error);

the *sip_get_next_value() function returns the value, if any, that follows the value that is specified by the value of the old_value parameter. This function does not return any values that are marked as deleted.

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

The *sip_get_param_value() function returns the parameter that is specified by the value of the param_name parameter from the SIP message header that is specified by the header_value parameter.

The value of the error parameter is set to zero when this function completes successfully. When this function completes unsuccessfully, it sets the value of the error parameter to the appropriate error value.

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

The *sip_get_params() function returns the parameter list that is associated with the value that is specified in the header_value parameter.

The value of the error parameter is set to zero when this function completes successfully. When this function completes unsuccessfully, it sets the value of the error parameter to the appropriate error value.

char *sip_get_resp_desc(int resp_code);

The *sip_get_resp_desc() function returns the reason phrase for the response code that is specified by the value of the resp_code parameter. This function supports the response codes that are listed in section 21 of RFC 3261. This function returns UNKNOWN for unknown response codes.