share/man/man3sip/sip_get_uri_parsed.3sip

   1 '\" te
   2 .\"  Copyright (c) 2007, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH SIP_GET_URI_PARSED 3SIP "Jan 25, 2007"
   7 .SH NAME
   8 sip_get_uri_parsed \- return the parsed URI
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lsip\fR [ \fIlibrary\fR ... ]
  13 #include <sip.h>
  14
  15 \fBconst struct sip_uri *\fR\fIsip_get_uri_parsed\fR(\fBsip_header_value_t\fR \fIvalue\fR,
  16      \fBint *\fR\fIerror\fR);
  17 .fi
  18
  19 .SH DESCRIPTION
  20 .sp
  21 .LP
  22 The \fBsip_get_uri_parsed()\fR function returns the parsed \fBURI\fR
  23 \fIsip_uri\fR from the \fBSIP\fR header value specified in \fIvalue\fR.
  24 .SH RETURN VALUES
  25 .sp
  26 .LP
  27 The \fBsip_get_uri_parsed()\fR function returns the parsed \fBURI\fR
  28 \fIsip_uri\fR on success. The function returns \fBNULL\fR on failure.
  29 .sp
  30 .LP
  31 The value of \fBerrno\fR is not changed by these calls in the event of an
  32 error.
  33 .SH ERRORS
  34 .sp
  35 .LP
  36 If the error is non-null, following value is set:
  37 .sp
  38 .ne 2
  39 .na
  40 \fB\fBEINVAL\fR\fR
  41 .ad
  42 .RS 10n
  43 The \fBSIP\fR header value of the \fBSIP\fR message is \fBNULL\fR or there is
  44 no \fBURI\fR.
  45 .sp
  46 The input \fBURI\fR is null or the requested \fBURI\fR component is invalid.
  47 The error flag is set for the requested component.
  48 .sp
  49 The \fBURI\fR parameters or headers are requested from a non-\fBSIP[S]\fR
  50 \fBURI\fR; or the '\fBopaque\fR', '\fBquery\fR', '\fBpath\fR', '\fBreg-name\fR'
  51 components are requested from a \fBSIP[S]\fR \fBURI\fR.
  52 .RE
  53
  54 .sp
  55 .LP
  56 On success, the value of the location pointed to by \fIerror\fR is set to
  57 \fB0\fR.
  58 .SH ATTRIBUTES
  59 .sp
  60 .LP
  61 See \fBattributes\fR(5) for descriptions of the following attributes:
  62 .sp
  63
  64 .sp
  65 .TS
  66 box;
  67 c | c
  68 l | l .
  69 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  70 _
  71 Interface Stability     Committed
  72 _
  73 MT-Level        MT-Safe
  74 .TE
  75
  76 .SH SEE ALSO
  77 .sp
  78 .LP
  79 \fBlibsip\fR(3LIB)