share/man/man3sip/sip_get_param_value.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_PARAM_VALUE 3SIP "Jan 25, 2007"
   7 .SH NAME
   8 sip_get_param_value, sip_get_params, sip_is_param_present \- get parameter
   9 information for a SIP header value
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lsip\fR [ \fIlibrary\fR ... ]
  14 #include <sip.h>
  15
  16 \fBconst sip_str_t *\fR\fIsip_get_param_value\fR
  17      (\fBsip_header_value_t\fR \fIheader_value\fR, \fBchar *\fR\fIparam_name\fR, \fBint *\fR\fIerror\fR);
  18 .fi
  19
  20 .LP
  21 .nf
  22 \fBconst sip_param_t *\fR\fIsip_get_params\fR
  23      (\fBsip_header_value_t\fR \fIheader_value\fR, \fBint *\fR\fIerror\fR);;
  24 .fi
  25
  26 .LP
  27 .nf
  28 \fBboolean_t\fR \fIsip_is_param_present\fR
  29      (\fBconst sip_param_t *\fR\fIparam_list\fR, \fBchar *\fR\fIparam_name\fR, \fBint\fR \fIparam_len\fR);
  30 .fi
  31
  32 .SH DESCRIPTION
  33 .sp
  34 .LP
  35 The \fBsip_get_param_value()\fR function returns the value for the parameter
  36 name specified by \fIparam_name\fR from the \fBSIP\fR header value
  37 \fIheader_value\fR.
  38 .sp
  39 .LP
  40 For functions that return a pointer of type \fBsip_str_t\fR, \fBsip_str_t\fR is
  41 supplied by:
  42 .sp
  43 .in +2
  44 .nf
  45 typedef struct sip_str {
  46         char    *sip_str_ptr;
  47         int     sip_str_len;
  48 }sip_str_t;
  49 .fi
  50 .in -2
  51
  52 .sp
  53 .LP
  54 The \fIsip_str_ptr\fR parameter points to the start of the returned value and
  55 \fIsip_str_len\fR supplies the length of the returned value.
  56 .sp
  57 .LP
  58 The \fBsip_get_params()\fR function returns the parameter list, if any, for the
  59 \fBSIP\fR header value \fIheader_value\fR.
  60 .sp
  61 .LP
  62 The \fBsip_is_param_present()\fR function returns \fBB_TRUE\fR if the parameter
  63 specified by \fIparam_name\fR of length supplied in \fIparam_len\fR is present
  64 in the parameter list, \fIparam_list\fR. Otherwise, it returns \fBB_FALSE\fR.
  65 .SH RETURN VALUES
  66 .sp
  67 .LP
  68 With the exception of \fBsip_is_param_present()\fR, these functions return the
  69 queried value on success and \fBNULL\fR on failure.
  70 .sp
  71 .LP
  72 The value of \fBerrno\fR is not changed by these calls in the event of an
  73 error.
  74 .SH ERRORS
  75 .sp
  76 .LP
  77 If the error is non-null, one of the following values is set:
  78 .sp
  79 .ne 2
  80 .na
  81 \fB\fBEINVAL\fR\fR
  82 .ad
  83 .RS 10n
  84 If any of the required input is \fBNULL\fR or if the specified \fBSIP\fR header
  85 value is marked deleted.
  86 .RE
  87
  88 .sp
  89 .ne 2
  90 .na
  91 \fB\fBEPROTO\fR\fR
  92 .ad
  93 .RS 10n
  94 If the returned \fBSIP\fR header value is invalid (i.e. the parser encountered
  95 errors when parsing the value).
  96 .RE
  97
  98 .sp
  99 .LP
 100 On success, the value of the location pointed to by \fIerror\fR is set to
 101 \fB0\fR.
 102 .SH ATTRIBUTES
 103 .sp
 104 .LP
 105 See \fBattributes\fR(5) for descriptions of the following attributes:
 106 .sp
 107
 108 .sp
 109 .TS
 110 box;
 111 c | c
 112 l | l .
 113 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 114 _
 115 Interface Stability     Committed
 116 _
 117 MT-Level        MT-Safe
 118 .TE
 119
 120 .SH SEE ALSO
 121 .sp
 122 .LP
 123 \fBlibsip\fR(3LIB)