xref: /illumos-gate/usr/src/man/man3commputil/sdp_session_to_str.3commputil (revision a89c0811c892ec231725fe10817ef95dda813c06)
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]
SDP_SESSION_TO_STR 3COMMPUTIL "Oct 12, 2007"
NAME
sdp_session_to_str - return a string representation of a session structure
SYNOPSIS

cc [ flag...] file... -lcommputil [ library...]
#include <sdp.h>

char *sdp_session_to_str(const sdp_session_t *session,
 int *error);
DESCRIPTION

The sdp_session_to_str() function returns the string representation of the SDP session structure session. The caller is responsible for freeing the returned string.

The function adds a CRLF at the end of each SDP field before appending that field to the string.

RETURN VALUES

The sdp_session_to_str() function returns the relevant string on success and NULL otherwise.

If error is non-null, the location pointed by error is set to 0 on success or the error value on failure. The value of errno is not changed by these calls in the event of an error.

ERRORS

The sdp_session_to_str() function will fail if: EINVAL

The input is null.

ENOMEM

A memory allocation failure occurred.

ATTRIBUTES

See attributes(7) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Committed
MT-Level Safe
SEE ALSO

libcommputil (3LIB), attributes (7)