Content-type: text/html Man page of sip_get_header_value

sip_get_header_value

Section: Session Initiation Protocol Library Functions (3SIP)
Updated: 20 Mar 2007
Index Return to Main Contents
 

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

ATTRIBUTE TYPEATTRIBUTE VALUE

Interface StabilityStable

MT-Level

 

SEE ALSO

libsip(3SIP)


 

Index

NAME
SYNOPSIS
DESCRIPTION
RETURN VALUES
ERRORS
ATTRIBUTES
SEE ALSO

This document was created by man2html, using the manual pages.
Time: 02:37:49 GMT, October 02, 2010