usr/src/man/man3commputil/sdp_new_session.3commputil

   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 SDP_NEW_SESSION 3COMMPUTIL "Oct 12, 2007"
   7 .SH NAME
   8 sdp_new_session, sdp_free_session \- allocate a new SDP session structure
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR...] \fIfile\fR... -\fBlcommputil\fR [ \fIlibrary\fR...]
  13 #include <sdp.h>
  14
  15 \fBsdp_session_t *\fR\fBsdp_new_session\fR();
  16 .fi
  17
  18 .LP
  19 .nf
  20 \fBvoid\fR \fBsdp_free_session\fR(\fBsdp_session_t *\fR\fIsession\fR);
  21 .fi
  22
  23 .SH DESCRIPTION
  24 .sp
  25 .LP
  26 The \fBsdp_new_session()\fR function allocates memory for an SDP session
  27 structure specified by \fIsession\fR, assigns a version number to the session
  28 structure, and returns a new session structure. It is the responsibility of the
  29 user to free the memory allocated to the session structure using the
  30 \fBsdp_free_session()\fR function.
  31 .sp
  32 .LP
  33 The \fBsdp_free_session()\fR function destroys the SDP session structure and
  34 frees the resources associated with it.
  35 .SH RETURN VALUES
  36 .sp
  37 .LP
  38 The \fBsdp_new_session()\fR function returns the newly allocated SDP session
  39 structure on success and \fINULL\fR on failure.
  40 .SH ATTRIBUTES
  41 .sp
  42 .LP
  43 See \fBattributes\fR(5) for descriptions of the following attributes:
  44 .sp
  45
  46 .sp
  47 .TS
  48 box;
  49 c | c
  50 l | l .
  51 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  52 _
  53 Interface Stability     Committed
  54 _
  55 MT-Level        Safe
  56 .TE
  57
  58 .SH SEE ALSO
  59 .sp
  60 .LP
  61 \fBlibcommputil\fR(3LIB), \fBattributes\fR(5)