share/man/man3sip/sip_add_param.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_ADD_PARAM 3SIP "Jan 25, 2007"
   7 .SH NAME
   8 sip_add_param \- add a parameter to the SIP header
   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 \fBsip_header_t\fR \fIsip_add_param\fR(\fBsip_header_t\fR \fIsip_header\fR, \fBchar *\fR\fIparam\fR,
  16      \fBint *\fR\fIerror\fR);
  17 .fi
  18
  19 .SH DESCRIPTION
  20 .sp
  21 .LP
  22 The \fBsip_add_param()\fR function adds the parameter provided in \fIparam\fR
  23 to the \fBSIP\fR header \fIsip_header\fR. The function returns the header with
  24 the parameter added. A new header is created as a result of adding the
  25 parameter and the old header is marked deleted. Applications with multiple
  26 threads working on the same \fBSIP\fR header need to take note of this. If
  27 error is non-null, it (the location pointer by the variable) is set to \fB0\fR
  28 on success and the appropriate error value on error.
  29 .SH RETURN VALUES
  30 .sp
  31 .LP
  32 The \fBsip_add_param()\fR function returns the new header on success and null
  33 on failure. Further, if error is non-null, then on success the value in the
  34 location pointed by error is \fB0\fR and the appropriate error value on
  35 failure.
  36 .SH ERRORS
  37 .sp
  38 .LP
  39 On failure, functions that return an error value may return one of the
  40 following:
  41 .sp
  42 .ne 2
  43 .na
  44 \fB\fBEINVAL\fR\fR
  45 .ad
  46 .RS 10n
  47 Mandatory parameters are not provided, i.e. null.
  48 .sp
  49 For \fBsip_add_param()\fR, the header to be modified is marked deleted.
  50 .RE
  51
  52 .sp
  53 .ne 2
  54 .na
  55 \fB\fBEPERM\fR\fR
  56 .ad
  57 .RS 10n
  58 The message cannot be modified.
  59 .RE
  60
  61 .sp
  62 .ne 2
  63 .na
  64 \fB\fBENOMEM\fR\fR
  65 .ad
  66 .RS 10n
  67 There is an error allocating memory for creating headers/parameters.
  68 .RE
  69
  70 .SH ATTRIBUTES
  71 .sp
  72 .LP
  73 See \fBattributes\fR(5) for descriptions of the following attributes:
  74 .sp
  75
  76 .sp
  77 .TS
  78 box;
  79 c | c
  80 l | l .
  81 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  82 _
  83 Interface Stability     Committed
  84 _
  85 MT-Level        MT-Safe
  86 .TE
  87
  88 .SH SEE ALSO
  89 .sp
  90 .LP
  91 \fBlibsip\fR(3LIB)