share/man/man3sip/sip_copy_start_line.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_COPY_START_LINE 3SIP "Jan 25, 2007"
   7 .SH NAME
   8 sip_copy_start_line, sip_copy_header, sip_copy_header_by_name,
   9 sip_copy_all_headers \- copy headers from a SIP message
  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 \fBint\fR \fIsip_copy_start_line\fR(\fBsip_msg_t\fR \fIfrom_msg\fR, \fBsip_msg_t\fR \fIto_msg\fR);
  17 .fi
  18
  19 .LP
  20 .nf
  21 \fBint\fR \fIsip_copy_header\fR(\fBsip_msg_t\fR \fIsip_msg\fR, \fBsip_header_t\fR \fIsip_header\fR,
  22      \fBchar *\fR\fIparam\fR);
  23 .fi
  24
  25 .LP
  26 .nf
  27 \fBint\fR \fIsip_copy_header_by_name\fR(\fBsip_msg_t\fR \fIfrom_msg\fR, \fBsip_msg_t\fR \fIto_msg\fR,
  28      \fBchar *\fR\fIheader_name\fR, \fBchar *\fR\fIparam\fR);
  29 .fi
  30
  31 .LP
  32 .nf
  33 \fBint\fR \fIsip_copy_all_headers\fR(\fBsip_msg_t\fR \fIfrom_msg\fR, \fBsip_msg_t\fR \fIto_msg\fR);
  34 .fi
  35
  36 .SH DESCRIPTION
  37 .sp
  38 .LP
  39 The \fBsip_copy_start_line()\fR function copies the start line, a request or a
  40 response line, from \fIfrom_msg\fR to \fIto_msg\fR.
  41 .sp
  42 .LP
  43 The \fBsip_copy_header()\fR function copies the \fBSIP\fR header specified by
  44 \fIsip_header\fR to the \fBSIP\fR message \fIsip_msg\fR. A new \fBSIP\fR header
  45 is created from \fIsip_header\fR and \fIparam\fR, and is appended to
  46 \fIsip_msg\fR. The \fIparam\fR can be non-null.
  47 .sp
  48 .LP
  49 The \fBsip_copy_header_by_name()\fR function copies the header specified by
  50 \fIheader_name\fR (long or short form) from \fIfrom_msg\fR to \fIto_msg\fR. The
  51 new header is created using the header value from \fIfrom_msg\fR and
  52 \fIparam\fR, if non-null, and appended to \fIto_msg\fR.
  53 .sp
  54 .LP
  55 The \fBsip_copy_all_headers()\fR copies all the headers from \fIfrom_msg\fR to
  56 \fIto_msg\fR.
  57 .SH RETURN VALUES
  58 .sp
  59 .LP
  60 These functions return \fB0\fR on success and the appropriate error on failure.
  61 .sp
  62 .LP
  63 The value of \fBerrno\fR is not changed by these calls in the event of an
  64 error.
  65 .SH ERRORS
  66 .sp
  67 .LP
  68 These functions can return one of the following errors in case of failure:
  69 .sp
  70 .ne 2
  71 .na
  72 \fB\fBEINVAL\fR\fR
  73 .ad
  74 .RS 10n
  75 If the required input parameters are \fBNULL\fR or if the header being copied
  76 does not exist or is deleted in source \fBSIP\fR message.
  77 .RE
  78
  79 .sp
  80 .ne 2
  81 .na
  82 \fB\fBENOMEM\fR\fR
  83 .ad
  84 .RS 10n
  85 Error while allocating memory for creating the new header.
  86 .RE
  87
  88 .sp
  89 .ne 2
  90 .na
  91 \fB\fBEPERM\fR\fR
  92 .ad
  93 .RS 10n
  94 If the input SIP message cannot be modified.
  95 .RE
  96
  97 .SH ATTRIBUTES
  98 .sp
  99 .LP
 100 See \fBattributes\fR(5) for descriptions of the following attributes:
 101 .sp
 102
 103 .sp
 104 .TS
 105 box;
 106 c | c
 107 l | l .
 108 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 109 _
 110 Interface Stability     Committed
 111 _
 112 MT-Level        MT-Safe
 113 .TE
 114
 115 .SH SEE ALSO
 116 .sp
 117 .LP
 118 \fBlibsip\fR(3LIB)