xref: /illumos-gate/usr/src/man/man3sip/sip_get_uri_parsed.3sip (revision 5422785d352a2bb398daceab3d1898a8aa64d006)
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_URI_PARSED 3SIP "Jan 25, 2007"
NAME
sip_get_uri_parsed - return the parsed URI
SYNOPSIS

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

const struct sip_uri *sip_get_uri_parsed(sip_header_value_t value,
 int *error);
DESCRIPTION

The sip_get_uri_parsed() function returns the parsed URI sip_uri from the SIP header value specified in value.

RETURN VALUES

The sip_get_uri_parsed() function returns the parsed URI sip_uri on success. The function returns 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, following value is set: EINVAL

The SIP header value of the SIP message is NULL or there is no URI. The input URI is null or the requested URI component is invalid. The error flag is set for the requested component. The URI parameters or headers are requested from a non-SIP[S] URI; or the 'opaque', 'query', 'path', 'reg-name' components are requested from a SIP[S] URI.

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)