SIP_GET_HEADER_VALUE(3SIP) Session Initiation Protocol Library Functions

NAME

sip_get_header_value, sip_get_next_value - get a SIP header value

SYNOPSIS

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

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


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

DESCRIPTION

The sip_get_header_value() function returns the first valid value
from SIP header sip_header.


The sip_get_next_value() function returns the next valid value
following the SIP value old_value.

RETURN VALUES

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(7) for descriptions of the following attributes:


+--------------------+-----------------+
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+--------------------+-----------------+
|Interface Stability | Committed |
+--------------------+-----------------+
|MT-Level | MT-Safe |
+--------------------+-----------------+

SEE ALSO

libsip(3LIB)

January 25, 2007 SIP_GET_HEADER_VALUE(3SIP)