share/man/man3sip/sip_add_header.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_HEADER 3SIP "Feb 09, 2007"
   7 .SH NAME
   8 sip_add_header \- add a SIP header to the SIP message
   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 \fBint\fR \fIsip_add_header\fR(\fBsip_msg_t\fR \fIsip_msg\fR, \fBchar *\fR\fIheader_string\fR);
  16 .fi
  17
  18 .SH DESCRIPTION
  19 .sp
  20 .LP
  21 The \fBsip_add_header()\fR function takes the \fBSIP\fR header
  22 \fIheader_string\fR, adds a \fBCRLF\fR (carriage return/line feed) and appends
  23 it to the \fBSIP\fR message \fIsip_msg\fR. The \fBsip_add_header()\fR function
  24 is typically used when adding a \fBSIP\fR header with multiple values.
  25 .SH RETURN VALUES
  26 .sp
  27 .LP
  28 The \fBsip_add_header()\fR function returns \fB0\fR on success and the
  29 appropriate error value on failure.
  30 .SH ERRORS
  31 .sp
  32 .LP
  33 On failure, the \fBsip_add_header()\fR function can return one of the following
  34 error values:
  35 .sp
  36 .ne 2
  37 .na
  38 \fB\fBEINVAL\fR\fR
  39 .ad
  40 .RS 10n
  41 Mandatory parameters are not provided, i.e. null.
  42 .RE
  43
  44 .sp
  45 .ne 2
  46 .na
  47 \fB\fBEPERM\fR\fR
  48 .ad
  49 .RS 10n
  50 The message cannot be modified.
  51 .RE
  52
  53 .sp
  54 .ne 2
  55 .na
  56 \fB\fBENOMEM\fR\fR
  57 .ad
  58 .RS 10n
  59 Error allocating memory for creating headers/parameters.
  60 .RE
  61
  62 .SH ATTRIBUTES
  63 .sp
  64 .LP
  65 See \fBattributes\fR(5) for descriptions of the following attributes:
  66 .sp
  67
  68 .sp
  69 .TS
  70 box;
  71 c | c
  72 l | l .
  73 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  74 _
  75 Interface Stability     Committed
  76 _
  77 MT-Level        MT-Safe
  78 .TE
  79
  80 .SH SEE ALSO
  81 .sp
  82 .LP
  83 \fBlibsip\fR(3LIB)