3
$NCDId: @(#)AuGetEl.man,v 1.1 1994/09/27 00:29:24 greg Exp $
4
copyright 1994 Steven King
7
* Copyright 1993 Network Computing Devices, Inc.
9
* Permission to use, copy, modify, distribute, and sell this software and its
10
* documentation for any purpose is hereby granted without fee, provided that
11
* the above copyright notice appear in all copies and that both that
12
* copyright notice and this permission notice appear in supporting
13
* documentation, and that the name Network Computing Devices, Inc. not be
14
* used in advertising or publicity pertaining to distribution of this
15
* software without specific, written prior permission.
17
* THIS SOFTWARE IS PROVIDED 'AS-IS'. NETWORK COMPUTING DEVICES, INC.,
18
* DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING WITHOUT
19
* LIMITATION ALL IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
20
* PARTICULAR PURPOSE, OR NONINFRINGEMENT. IN NO EVENT SHALL NETWORK
21
* COMPUTING DEVICES, INC., BE LIABLE FOR ANY DAMAGES WHATSOEVER, INCLUDING
22
* SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES, INCLUDING LOSS OF USE, DATA,
23
* OR PROFITS, EVEN IF ADVISED OF THE POSSIBILITY THEREOF, AND REGARDLESS OF
24
* WHETHER IN AN ACTION IN CONTRACT, TORT OR NEGLIGENCE, ARISING OUT OF OR IN
25
* CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
27
$Id: AuGetElements.3.html 243 2007-04-07 23:13:43Z jon $
30
<!-- manual page source format generated by PolyglotMan v3.0.8+X.Org, -->
31
<!-- available at http://polyglotman.sourceforge.net/ -->
35
<title>AuGetElements(3) manual page</title>
37
<body bgcolor='#efefef' text='black' link='blue' vlink='#551A8B' alink='red'>
38
<a href='#toc'>Table of Contents</a><p>
40
<h2><a name='sect0' href='#toc0'><b>Name</b></a></h2>
41
<b>AuGetElements</b> - get the elements in a flow
43
<h2><a name='sect1' href='#toc1'><b>Synopsis</b></a></h2>
44
#include <audio/audiolib.h> <p>
45
<b>AuElement</b> *<b>AuGetElements</b>(<i>server</i>, <i>flow</i>,
46
<i>clocked</i>, <i>num_elements</i>, <i>status</i>) <br>
47
<b>AuServer</b> *<i>server</i>;<br>
49
<b>AuFlowID</b> <i>flow</i>;<br>
51
<b>AuBool</b> *<i>clocked</i>; /* <b>RETURN</b> */<br>
53
int *<i>num_elements</i>; /* <b>RETURN</b> */<br>
55
<b>AuStatus</b> *<i>status</i>; /* <b>RETURN</b> */<br>
57
<h2><a name='sect2' href='#toc2'><b>Arguments</b></a></h2>
61
<dt><i>server</i></dt>
62
<dd>Specifies the connection to the audio server. </dd>
66
the ID of the flow to get the elements from. </dd>
68
<dt><i>clocked</i></dt>
69
<dd>Returns a boolean value
70
that indicates if the flow is clocked. </dd>
72
<dt><i>num_elements</i></dt>
73
<dd>Returns the number of
76
<dt><i>status</i></dt>
77
<dd>If non-NULL, flush the output buffer and return the status
78
from the server. </dd>
81
<h2><a name='sect3' href='#toc3'><b>Description</b></a></h2>
82
<b>AuGetElements</b> returns the list of elements comprising
83
<i>flow</i> or NULL, with <i>num_elements</i> set to 0, if there was an error. Use <b>AuFreeElements</b>
84
to free this list when nolonger needed.
85
<h2><a name='sect4' href='#toc4'><b>Errors</b></a></h2>
87
<h2><a name='sect5' href='#toc5'><b>See Also</b></a></h2>
90
audiolib - <b>Network Audio System</b> C Language Interface <p>
93
<a name='toc'><b>Table of Contents</b></a><p>
95
<li><a name='toc0' href='#sect0'>Name</a></li>
96
<li><a name='toc1' href='#sect1'>Synopsis</a></li>
97
<li><a name='toc2' href='#sect2'>Arguments</a></li>
98
<li><a name='toc3' href='#sect3'>Description</a></li>
99
<li><a name='toc4' href='#sect4'>Errors</a></li>
100
<li><a name='toc5' href='#sect5'>See Also</a></li>