share/man/man3sip/sip_clone_msg.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_CLONE_MSG 3SIP "Jan 25, 2007"
   7 .SH NAME
   8 sip_clone_msg \- clone a 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 \fBsip_msg_t\fR \fIsip_clone_msg\fR(\fBsip_msg_t\fR \fIsip_msg\fR);
  16 .fi
  17
  18 .SH DESCRIPTION
  19 .sp
  20 .LP
  21 The \fBsip_clone_msg()\fR function clones the input \fBSIP\fR message and
  22 returns the cloned message. The resulting cloned message has all the \fBSIP\fR
  23 headers and message body, if present, from the input message.
  24 .SH RETURN VALUES
  25 .sp
  26 .LP
  27 The \fBsip_clone_msg()\fR function returns the cloned message on success and
  28 \fBNULL\fR on failure.
  29 .sp
  30 .LP
  31 The value of \fBerrno\fR is not changed by these calls in the event of an
  32 error.
  33 .SH ATTRIBUTES
  34 .sp
  35 .LP
  36 See \fBattributes\fR(5) for descriptions of the following attributes:
  37 .sp
  38
  39 .sp
  40 .TS
  41 box;
  42 c | c
  43 l | l .
  44 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  45 _
  46 Interface Stability     Committed
  47 _
  48 MT-Level        MT-Safe
  49 .TE
  50
  51 .SH SEE ALSO
  52 .sp
  53 .LP
  54 \fBlibsip\fR(3LIB)