share/man/man3sip/sip_new_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_NEW_MSG 3SIP "Jan 25, 2007"
   7 .SH NAME
   8 sip_new_msg \- allocates a new 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_new_msg\fR();
  16 .fi
  17
  18 .SH DESCRIPTION
  19 .sp
  20 .LP
  21 The \fBsip_new_msg()\fR function allocates and returns a new \fBSIP\fR message.
  22 .SH RETURN VALUES
  23 .sp
  24 .LP
  25 The \fBsip_new_msg()\fR function returns the newly allocated \fBSIP\fR message
  26 on success and \fINULL\fR on failure.
  27 .sp
  28 .LP
  29 The value of \fBerrno\fR is not changed by these calls in the event of an
  30 error.
  31 .SH ATTRIBUTES
  32 .sp
  33 .LP
  34 See \fBattributes\fR(5) for descriptions of the following attributes:
  35 .sp
  36
  37 .sp
  38 .TS
  39 box;
  40 c | c
  41 l | l .
  42 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  43 _
  44 Interface Stability     Committed
  45 _
  46 MT-Level        MT-Safe
  47 .TE
  48
  49 .SH SEE ALSO
  50 .sp
  51 .LP
  52 \fBlibsip\fR(3LIB)