xref: /illumos-gate/usr/src/man/man3sip/sip_get_header_value.3sip (revision 7bb0eb348e1119aed76a61d633a9106b6b9912f1)
te
Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
SIP_GET_HEADER_VALUE 3SIP "Jan 25, 2007"
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)