File: AuGetElementStates.3.html

package info (click to toggle)
nas 1.9.4-9
  • links: PTS, VCS
  • area: main
  • in suites: forky, trixie
  • size: 8,640 kB
  • sloc: ansic: 52,144; makefile: 31,376; sh: 8,077; perl: 1,104; yacc: 252; cpp: 216; lex: 68
file content (105 lines) | stat: -rw-r--r-- 4,085 bytes parent folder | download | duplicates (9)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105

<!--
  $NCDId: @(#)AuGElSt.man,v 1.1 1994/09/27 00:28:44 greg Exp $
   copyright 1994 Steven King
   
   portions are
   * Copyright 1993 Network Computing Devices, Inc.
   *
   * Permission to use, copy, modify, distribute, and sell this software and its
   * documentation for any purpose is hereby granted without fee, provided that
   * the above copyright notice appear in all copies and that both that
   * copyright notice and this permission notice appear in supporting
   * documentation, and that the name Network Computing Devices, Inc. not be
   * used in advertising or publicity pertaining to distribution of this
   * software without specific, written prior permission.
   * 
   * THIS SOFTWARE IS PROVIDED 'AS-IS'.  NETWORK COMPUTING DEVICES, INC.,
   * DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING WITHOUT
   * LIMITATION ALL IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
   * PARTICULAR PURPOSE, OR NONINFRINGEMENT.  IN NO EVENT SHALL NETWORK
   * COMPUTING DEVICES, INC., BE LIABLE FOR ANY DAMAGES WHATSOEVER, INCLUDING
   * SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES, INCLUDING LOSS OF USE, DATA,
   * OR PROFITS, EVEN IF ADVISED OF THE POSSIBILITY THEREOF, AND REGARDLESS OF
   * WHETHER IN AN ACTION IN CONTRACT, TORT OR NEGLIGENCE, ARISING OUT OF OR IN
   * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
   
   $Id: AuGetElementStates.3.html 243 2007-04-07 23:13:43Z jon $
 
-->
<!-- manual page source format generated by PolyglotMan v3.0.8+X.Org, -->
<!-- available at http://polyglotman.sourceforge.net/ -->

<html>
<head>
<title>AuGetElementStates(3) manual page</title>
</head>
<body bgcolor='#efefef' text='black' link='blue' vlink='#551A8B' alink='red'>
<a href='#toc'>Table of Contents</a><p>

<h2><a name='sect0' href='#toc0'><b>Name</b></a></h2>
<b>AuGetElementStates</b> - get the state of elements
in a flow 
<h2><a name='sect1' href='#toc1'><b>Synopsis</b></a></h2>
#include &lt;audio/audiolib.h&gt; <p>
<b>AuElementState</b> *<b>AuGetElementStates</b>(<i>server</i>,
<i>num_states</i>, <i>states</i>, <i>status</i>) <br>
    <b>AuServer</b> *<i>server</i>;<br>
 <br>
    int *<i>num_states</i>; /* <b>SEND</b> and <b>RETURN</b> */<br>
 <br>
    <b>AuElementState</b> *<i>states</i>;<br>
 <br>
    <b>AuStatus</b> *<i>status</i>; /* <b>RETURN</b> */<br>
 
<h2><a name='sect2' href='#toc2'><b>Arguments</b></a></h2>

<dl>

<dt><i>server</i></dt>
<dd>Specifies the connection to the audio server. </dd>

<dt><i>num_states</i></dt>
<dd>Specifies
the number of element states in <i>states</i> and returns the number of element
states actually returned. </dd>

<dt><i>states</i></dt>
<dd>Specifies the list  of <b>AuElementState</b> structures
indicating the flow and element number of the elements to return the state
of. </dd>

<dt><i>status</i></dt>
<dd>If non-NULL, flush the output buffer and return the status from
the server. </dd>
</dl>

<h2><a name='sect3' href='#toc3'><b>Description</b></a></h2>
<b>AuGetElementStates</b> returns a list of element states,
or NULL, with num_states set to 0, if there was an error. Use <b>AuFreeElementStates</b>
to free this list when nolonger needed. 
<h2><a name='sect4' href='#toc4'>Notes</a></h2>
Attempting to get the state
of a non-component element (AddConstant, Bundle, ExportMonitor, MultiplyConstant,
and Sum) will result in an error. 
<h2><a name='sect5' href='#toc5'><b>Errors</b></a></h2>
<b>AuBadFlow</b>, <b>AuBadLength</b>, <b>AuBadAlloc</b>,
<b>AuBadElement</b>. 
<h2><a name='sect6' href='#toc6'><b>See Also</b></a></h2>
<b>AuSetElementStates</b>. <p>
audiolib - <b>Network Audio System</b>
C Language Interface <p>

<hr><p>
<a name='toc'><b>Table of Contents</b></a><p>
<ul>
<li><a name='toc0' href='#sect0'>Name</a></li>
<li><a name='toc1' href='#sect1'>Synopsis</a></li>
<li><a name='toc2' href='#sect2'>Arguments</a></li>
<li><a name='toc3' href='#sect3'>Description</a></li>
<li><a name='toc4' href='#sect4'>Notes</a></li>
<li><a name='toc5' href='#sect5'>Errors</a></li>
<li><a name='toc6' href='#sect6'>See Also</a></li>
</ul>
</body>
</html>