'\" te
.\" Copyright (c) 2007, Sun Microsystems Inc. All Rights Reserved.
.\" 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.
.\" 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.
.\" 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]
.TH SDP_SESSION_TO_STR 3COMMPUTIL "Oct 12, 2007"
.SH NAME
sdp_session_to_str \- return a string representation of a session structure
.SH SYNOPSIS
.LP
.nf
\fBcc\fR [ \fIflag\fR...] \fIfile\fR... -\fBlcommputil\fR [ \fIlibrary\fR...]
#include <sdp.h>

\fBchar *\fR\fBsdp_session_to_str\fR(\fBconst sdp_session_t *\fR\fIsession\fR,
     \fBint *\fR\fIerror\fR);
.fi

.SH DESCRIPTION
.sp
.LP
The \fBsdp_session_to_str()\fR function returns the string representation of
the SDP session structure \fIsession\fR. The caller is responsible for freeing
the returned string.
.sp
.LP
The function adds a CRLF at the end of each SDP field before appending that
field to the string.
.SH RETURN VALUES
.sp
.LP
The \fBsdp_session_to_str()\fR function returns the relevant string on success
and \fINULL\fR otherwise.
.sp
.LP
If \fIerror\fR is non-null, the location pointed by \fIerror\fR is set to 0 on
success or the error value on failure. The value of \fBerrno\fR is not changed
by these calls in the event of an error.
.SH ERRORS
.sp
.LP
The \fBsdp_session_to_str()\fR function will fail if:
.sp
.ne 2
.na
\fB\fBEINVAL\fR\fR
.ad
.RS 10n
The input is null.
.RE

.sp
.ne 2
.na
\fB\fBENOMEM\fR\fR
.ad
.RS 10n
A memory allocation failure occurred.
.RE

.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(7) for descriptions of the following attributes:
.sp

.sp
.TS
box;
c | c
l | l .
ATTRIBUTE TYPE	ATTRIBUTE VALUE
_
Interface Stability	Committed
_
MT-Level	Safe
.TE

.SH SEE ALSO
.sp
.LP
.BR libcommputil (3LIB),
.BR attributes (7)