usr/src/man/man3commputil/sdp_find_attribute.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_FIND_ATTRIBUTE 3COMMPUTIL "Oct 12, 2007"
   7 .SH NAME
   8 sdp_find_attribute \- find the attribute from the attribute list
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR...] \fIfile\fR... -\fBlcommputil\fR [ \fIlibrary\fR...]
  13 #include <sdp.h>
  14
  15 \fBsdp_attr_t *\fR\fBsdp_find_attribute\fR(\fBsdp_attr_t *\fR\fIattr\fR, \fBconst char *\fR\fIname\fR);
  16 .fi
  17
  18 .SH DESCRIPTION
  19 .sp
  20 .LP
  21 The \fBsdp_find_attribute()\fR function searches the attribute list \fIattr\fR
  22 for the specified attribute \fIname\fR. If the attribute is found it returns
  23 the pointer to that attribute. Otherwise it returns \fINULL\fR.
  24 .SH RETURN VALUES
  25 .sp
  26 .LP
  27 The \fBsdp_find_attribute()\fR function returns the attribute (\fBsdp_attr_t
  28 *\fR) on success and \fINULL\fR when the search fails or when mandatory input
  29 parameters are \fINULL\fR.
  30 .SH EXAMPLES
  31 .LP
  32 \fBExample 1 \fRAn (incomplete) SDP description that contains one media
  33 section: audio.
  34 .sp
  35 .in +2
  36 .nf
  37 m=audio 49170 RTP/AVP 0 8
  38 a=rtpmap:0 PCMU/8000
  39 a=rtpmap:8 PCMA/8000
  40 a=sendonly
  41 a=ptime:10000
  42 a=maxptime:20000
  43
  44 /*
  45  * Assuming that above description is parsed using sdp_parse and that
  46  * the parsed structure is in "session" sdp_session_t structure.
  47  */
  48
  49 sdp_attr_t *ptime;
  50 sdp_attr_t *max_ptime;
  51 sdp_media_t *media = session->s_media;
  52
  53 if ((ptime = sdp_find_attribute(media->m_attr, "ptime")) == NULL)
  54         /* ptime attribute not present */
  55 else if((max_ptime = sdp_find_attribute(media->m_attr,
  56          "maxptime")) == NULL)
  57         /* max_ptime attribute not present */
  58 .fi
  59 .in -2
  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_parse\fR(3COMMPUTIL), \fBattributes\fR(5)