xref: /illumos-gate/usr/src/man/man3commputil/sdp_delete_all_field.3commputil (revision 8226594fdd4479be135127f43632f1f995074654)
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_DELETE_ALL_FIELD 3COMMPUTIL "Oct 12, 2007"
NAME
sdp_delete_all_field, sdp_delete_all_media_field - delete all SDP fields
SYNOPSIS

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

int sdp_delete_all_field(sdp_session_t *session,
 const char field);

int sdp_delete_all_media_field(sdp_media_t *media,
 const char field);
DESCRIPTION

The sdp_delete_all_field() function deletes all the occurrences of the specified SDP field from the session structure. For example, if the session structure has 3 bandwidth (b=) fields, then when this function is called with SDP_BANDWIDTH_FIELD, all the three bandwidth fields are deleted from the session structure.

The sdp_delete_all_media_field() function deletes all the occurrences of the specified SDP field from the specified media structure. For example, if the caller wants to delete all the attribute fields in a media structure, calling this function with SDP_ATTRIBUTE_FIELD argument would delete all the attribute fields in the media structure.

RETURN VALUES

Upon successful completion, these functions return 0. Otherwise, the appropriate error value is returned. The value of errno is not changed by these calls in the event of an error.

ERRORS

These functions will fail if: EINVAL

The session or media argument is NULL or the field type is unknown.

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)