share/man/man3sip/sip_get_request_uri_str.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_REQUEST_URI_STR 3SIP "Jan 25, 2007"
   7 .SH NAME
   8 sip_get_request_uri_str \- return request 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 sip_str_t *\fR\fIsip_get_request_uri_str\fR(\fBsip_msg_t\fR \fIsip_msg\fR,
  16      \fBint *\fR\fIerror\fR);
  17 .fi
  18
  19 .SH DESCRIPTION
  20 .sp
  21 .LP
  22 For functions that return a pointer of type \fIsip_str_t\fR, \fIsip_str_t\fR is
  23 supplied by:
  24 .sp
  25 .in +2
  26 .nf
  27 typedef struct sip_str {
  28      char *sip_str_ptr;
  29      int  sip_str_len;
  30 }sip_str_t;
  31 .fi
  32 .in -2
  33
  34 .sp
  35 .LP
  36 The \fIsip_str_ptr\fR parameter points to the start of the returned value and
  37 \fIsip_str_len\fR supplies the length of the returned value.
  38 .sp
  39 .LP
  40 For example, given the following request line in a \fBSIP\fR message input to
  41 \fBsip_get_request_uri_str()\fR:
  42 .sp
  43 .in +2
  44 .nf
  45 INVITE sip:marconi@radio.org SIP/2.0
  46 .fi
  47 .in -2
  48
  49 .sp
  50 .LP
  51 the return is a pointer to \fIsip_str_t\fR with the \fIsip_str_ptr\fR member
  52 pointing to "\fBs\fR" of \fBsip:marconi@radio.org\fR and \fIsip_str_len\fR
  53 being set to \fB21\fR, the length of \fBsip:marconi@radio.org\fR.
  54 .sp
  55 .LP
  56 The \fBsip_get_request_uri_str()\fR function returns the \fBURI\fR string from
  57 the request line in the \fBSIP\fR message \fIsip_msg\fR.
  58 .SH RETURN VALUES
  59 .sp
  60 .LP
  61 The \fBsip_get_request_uri_str()\fR function returns the \fBURI\fR string. The
  62 function returns \fBNULL\fR on failure.
  63 .sp
  64 .LP
  65 The value of \fBerrno\fR is not changed by these calls in the event of an
  66 error.
  67 .SH ERRORS
  68 .sp
  69 .LP
  70 If the error is non-null, one of the following values is set:
  71 .sp
  72 .ne 2
  73 .na
  74 \fB\fBEINVAL\fR\fR
  75 .ad
  76 .RS 10n
  77 For the \fBsip_get_request_uri_str()\fR function, there is no request line is
  78 in the \fBSIP\fR message.
  79 .RE
  80
  81 .sp
  82 .ne 2
  83 .na
  84 \fB\fBEPROTO\fR\fR
  85 .ad
  86 .RS 10n
  87 For \fIsip_get_request_uri_str\fR, the request \fBURI\fR is invalid.
  88 .RE
  89
  90 .sp
  91 .LP
  92 On success, the value of the location pointed to by \fIerror\fR is set to
  93 \fB0\fR.
  94 .SH ATTRIBUTES
  95 .sp
  96 .LP
  97 See \fBattributes\fR(5) for descriptions of the following attributes:
  98 .sp
  99
 100 .sp
 101 .TS
 102 box;
 103 c | c
 104 l | l .
 105 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 106 _
 107 Interface Stability     Committed
 108 _
 109 MT-Level        MT-Safe
 110 .TE
 111
 112 .SH SEE ALSO
 113 .sp
 114 .LP
 115 \fBlibsip\fR(3LIB)