share/man/man3commputil/sdp_delete_all_field.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_DELETE_ALL_FIELD 3COMMPUTIL "Oct 12, 2007"
   7 .SH NAME
   8 sdp_delete_all_field, sdp_delete_all_media_field \- delete all SDP fields
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR...] \fIfile\fR... -\fBlcommputil\fR [ \fIlibrary\fR...]
  13 #include <sdp.h>
  14
  15 \fBint\fR \fBsdp_delete_all_field\fR(\fBsdp_session_t *\fR\fIsession\fR,
  16      \fBconst char\fR \fIfield\fR);
  17 .fi
  18
  19 .LP
  20 .nf
  21 \fBint\fR \fBsdp_delete_all_media_field\fR(\fBsdp_media_t *\fR\fImedia\fR,
  22      \fBconst char\fR \fIfield\fR);
  23 .fi
  24
  25 .SH DESCRIPTION
  26 .sp
  27 .LP
  28 The \fBsdp_delete_all_field()\fR function deletes all the occurrences of the
  29 specified SDP field from the session structure. For example, if the session
  30 structure has 3 bandwidth (b=) fields, then when this function is called with
  31 \fBSDP_BANDWIDTH_FIELD\fR, all the three bandwidth fields are deleted from the
  32 session structure.
  33 .sp
  34 .LP
  35 The \fBsdp_delete_all_media_field()\fR function deletes all the occurrences of
  36 the specified SDP field from the specified media structure. For example, if the
  37 caller wants to delete all the attribute fields in a media structure, calling
  38 this function with \fBSDP_ATTRIBUTE_FIELD\fR argument would delete all the
  39 attribute fields in the media structure.
  40 .SH RETURN VALUES
  41 .sp
  42 .LP
  43 Upon successful completion, these functions return 0. Otherwise, the
  44 appropriate error value is returned. The value of \fBerrno\fR is not changed by
  45 these calls in the event of an error.
  46 .SH ERRORS
  47 .sp
  48 .LP
  49 These functions will fail if:
  50 .sp
  51 .ne 2
  52 .na
  53 \fB\fBEINVAL\fR\fR
  54 .ad
  55 .RS 10n
  56 The \fIsession\fR or \fImedia\fR argument is \fINULL\fR or the field type is
  57 unknown.
  58 .RE
  59
  60 .SH ATTRIBUTES
  61 .sp
  62 .LP
  63 See \fBattributes\fR(5) for descriptions of the following attributes:
  64 .sp
  65
  66 .sp
  67 .TS
  68 box;
  69 c | c
  70 l | l .
  71 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  72 _
  73 Interface Stability     Committed
  74 _
  75 MT-Level        Safe
  76 .TE
  77
  78 .SH SEE ALSO
  79 .sp
  80 .LP
  81 \fBlibcommputil\fR(3LIB), \fBattributes\fR(5)