share/man/man3commputil/sdp_delete_media.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_MEDIA 3COMMPUTIL "Oct 12, 2007"
   7 .SH NAME
   8 sdp_delete_media, sdp_delete_attribute \- delete the specified media or
   9 attribute from the appropriate list
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fBcc\fR [ \fIflag\fR...] \fIfile\fR... -\fBlcommputil\fR [ \fIlibrary\fR...]
  14 #include <sdp.h>
  15
  16 \fBint\fR \fBsdp_delete_media\fR(\fBsdp_media_t **\fR\fIl_media\fR, \fBsdp_media_t *\fR\fImedia\fR);
  17 .fi
  18
  19 .LP
  20 .nf
  21 \fBint\fR \fBsdp_delete_attribute\fR(\fBsdp_attr_t **\fR\fIl_attr\fR, \fBsdp_attr_t *\fR\fIattr\fR);
  22 .fi
  23
  24 .SH DESCRIPTION
  25 .sp
  26 .LP
  27 The \fBsdp_delete_media()\fR function deletes the specified media from the
  28 media list. It is similar to deleting a node in a linked list. The function
  29 first finds the media that needs to be deleted using
  30 \fBsdp_find_media\fR(3COMMPUTIL). The found media is then passed to
  31 \fBsdp_delete_media()\fR to delete it. The function frees the memory allocated
  32 to media structure after deleting it.
  33 .sp
  34 .LP
  35 The \fBsdp_delete_attribute()\fR function deletes the specified attribute from
  36 the attribute list. It is similar to deleting a node in a linked list. The
  37 function first finds the attribute that needs to be deleted using
  38 \fBsdp_find_media_rtpmap\fR(3COMMPUTIL) or
  39 \fBsdp_find_attribute\fR(3COMMPUTIL). The found attribute is then passed to
  40 \fBsdp_delete_attribute()\fR to delete it. The function frees the memory
  41 allocated to attribute structure after deleting it.
  42 .SH RETURN VALUES
  43 .sp
  44 .LP
  45 Upon successful completion, these functions return 0. Otherwise, the
  46 appropriate error value is returned. The value of \fBerrno\fR is not changed by
  47 these calls in the event of an error.
  48 .SH ERRORS
  49 .sp
  50 .LP
  51 These functions will fail if:
  52 .sp
  53 .ne 2
  54 .na
  55 \fB\fBEINVAL\fR\fR
  56 .ad
  57 .RS 10n
  58 The mandatory input parameters are not provided or are \fINULL\fR.
  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), \fBsdp_find_attribute\fR(3COMMPUTIL),
  83 \fBsdp_find_media\fR(3COMMPUTIL), \fBsdp_find_media_rtpmap\fR(3COMMPUTIL),
  84 \fBattributes\fR(5)