share/man/man3commputil/sdp_session_to_str.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_SESSION_TO_STR 3COMMPUTIL "Oct 12, 2007"
   7 .SH NAME
   8 sdp_session_to_str \- return a string representation of a 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 \fBchar *\fR\fBsdp_session_to_str\fR(\fBconst sdp_session_t *\fR\fIsession\fR,
  16      \fBint *\fR\fIerror\fR);
  17 .fi
  18
  19 .SH DESCRIPTION
  20 .sp
  21 .LP
  22 The \fBsdp_session_to_str()\fR function returns the string representation of
  23 the SDP session structure \fIsession\fR. The caller is responsible for freeing
  24 the returned string.
  25 .sp
  26 .LP
  27 The function adds a CRLF at the end of each SDP field before appending that
  28 field to the string.
  29 .SH RETURN VALUES
  30 .sp
  31 .LP
  32 The \fBsdp_session_to_str()\fR function returns the relevant string on success
  33 and \fINULL\fR otherwise.
  34 .sp
  35 .LP
  36 If \fIerror\fR is non-null, the location pointed by \fIerror\fR is set to 0 on
  37 success or the error value on failure. The value of \fBerrno\fR is not changed
  38 by these calls in the event of an error.
  39 .SH ERRORS
  40 .sp
  41 .LP
  42 The \fBsdp_session_to_str()\fR function will fail if:
  43 .sp
  44 .ne 2
  45 .na
  46 \fB\fBEINVAL\fR\fR
  47 .ad
  48 .RS 10n
  49 The input is null.
  50 .RE
  51
  52 .sp
  53 .ne 2
  54 .na
  55 \fB\fBENOMEM\fR\fR
  56 .ad
  57 .RS 10n
  58 A memory allocation failure occurred.
  59 .RE
  60
  61 .SH ATTRIBUTES
  62 .sp
  63 .LP
  64 See \fBattributes\fR(5) for descriptions of the following attributes:
  65 .sp
  66
  67 .sp
  68 .TS
  69 box;
  70 c | c
  71 l | l .
  72 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  73 _
  74 Interface Stability     Committed
  75 _
  76 MT-Level        Safe
  77 .TE
  78
  79 .SH SEE ALSO
  80 .sp
  81 .LP
  82 \fBlibcommputil\fR(3LIB), \fBattributes\fR(5)