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
106
107
108
109
|
<!--
$NCDId: @(#)AuScFEvt.man,v 1.1 1994/09/27 00:36:28 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: AuScanForTypedEvent.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>AuScanForTypedEvent(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>AuScanForTypedEvent</b> - return the first event
of a specific type
<h2><a name='sect1' href='#toc1'><b>Synopsis</b></a></h2>
#include <audio/audiolib.h> <p>
<b>AuBool</b> <b>AuScanForTypedEvent</b>(<i>server</i>,
<i>mode</i>, <i>dequeue</i>, <i>type</i>, <i>event</i>) <br>
<b>AuServer</b> *<i>server</i>;<br>
<br>
int <i>mode</i>;<br>
<br>
<b>AuBool</b> <i>dequeue</i>;<br>
<br>
int <i>type</i>;<br>
<br>
<b>AuEvent</b> *<i>event</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>mode</i></dt>
<dd>Specifies
how far to look for a match. This should be one of these constants: <b>AuEventsQueuedAlready</b>,
<b>AuEventsQueuedAfterReading</b>, or <b>AuEventsQueuedAfterFlush</b>. </dd>
<dt><i>dequeue</i></dt>
<dd>Specifies
if a matching event is found, should it be removed from the queue. </dd>
<dt><i>type</i></dt>
<dd>Specifies
the type of event to match. The type should be one of these constants:
<b>AuEventTypeElementNotify</b>, <b>AuEventTypeGrabNotify</b>, or <b>AuEventTypeMonitorNotify</b>.
</dd>
<dt><i>event</i></dt>
<dd>Returns the matching event if found. </dd>
</dl>
<h2><a name='sect3' href='#toc3'><b>Description</b></a></h2>
<b>AuScanForTypedEvent</b>
scans the event queue looking for the first event that matches <i>type</i>. If
<i>mode</i> is <b>AuEventsQueuedAlready</b>, <b>AuScanForTypedEvent</b> only checks for events
already in the queue. If <i>mode</i> is <b>AuEventsQueuedAfterReading</b>, and a matching
event isn't found already in the queue, <b>AuScanForTypedEvent</b> attempts to
read more events out of the application's connection. If <i>mode</i> is <b>AuEventsQueuedAfterFlush</b>
and a matching event isn't already in the queue or isn't waiting to be read,
<b>AuScanForTypedEvent</b> flushes the output queue and attempts to read more
events out of the application's connection. If <i>dequeue</i> is <b>AuTrue</b>, and a matching
event is found, it is removed from the queue.
<h2><a name='sect4' href='#toc4'><b>See Also</b></a></h2>
<b>AuEventsQueued</b>, <b>AuScanEvents</b>,
<b>AuNextEvent</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'>See Also</a></li>
</ul>
</body>
</html>
|
