auscanevents(3) [debian man page]
AuScanEvents(3) Library Functions Manual AuScanEvents(3) Name AuScanEvents - return the first event that satisfies the predicate Synopsis #include <audio/audiolib.h> AuBool AuScanEvents(server, mode, dequeue, predicate, arg, event) AuServer *server; int mode; AuBool dequeue; AuBool (*predicate)(AuServer *,AuEvent *, AuPointer); AuPointer arg; AuEvent *event; /* RETURN */ Arguments server Specifies the connection to the audio server. mode Specifies how far to look for a match. This should be one of these constants: AuEventsQueuedAlready, AuEventsQueuedAfterReading, or AuEventsQueuedAfterFlush. dequeue Specifies if a matching event is found, should it be removed from the queue. predicate Specifies the procedure that is called to determine if an event matches the criteria. arg Specifies any additional arguments to be passed to the predicate procedure. event Returns the matching event if found. Description AuScanEvents scans the event queue looking for the first event that satisfies the caller-supplied predicate. If mode is AuEventsQueuedAl- ready, AuScanEvents only checks for events already in the queue. If mode is AuEventsQueuedAfterReading, and a matching event isn't found already in the queue, AuScanEvents attempts to read more events out of the application's connection. If mode is AuEventsQueuedAfterFlush and a matching event isn't already in the queue or isn't waiting to be read, AuScanEvents flushes the output queue and attempts to read more events out of the application's connection. If dequeue is AuTrue, and a matching event is found, it is removed from the queue. The predicate procedure is called with the arguments server, event, and arg and should return AuTrue to indicate a match. See Also AuEventsQueued, AuScanForTypedEvent, AuNextEvent. audiolib - Network Audio System C Language Interface audiolib - event handling 1.9.3 AuScanEvents(3)
Check Out this Related Man Page
XIfEvent(3X11) MIT X11R4 XIfEvent(3X11) Name XIfEvent, XCheckIfEvent, XPeekIfEvent - check the event queue with a predicate procedure Syntax XIfEvent(display, event_return, predicate, arg) Display *display; XEvent *event_return; Bool (*predicate)(); char *arg; Bool XCheckIfEvent(display, event_return, predicate, arg) Display *display; XEvent *event_return; Bool (*predicate)(); char *arg; XPeekIfEvent(display, event_return, predicate, arg) Display *display; XEvent *event_return; Bool (*predicate)(); char *arg; Arguments arg Specifies the user-supplied argument that will be passed to the predicate procedure. display Specifies the connection to the X server. event_return Returns either a copy of or the matched event's associated structure. predicate Specifies the procedure that is to be called to determine if the next event in the queue matches what you want. Description The function completes only when the specified predicate procedure returns for an event, which indicates an event in the queue matches. flushes the output buffer if it blocks waiting for additional events. removes the matching event from the queue and copies the structure into the client-supplied structure. When the predicate procedure finds a match, copies the matched event into the client-supplied structure and returns (This event is removed from the queue.) If the predicate procedure finds no match, returns and the output buffer will have been flushed. All earlier events stored in the queue are not discarded. The function returns only when the specified predicate procedure returns for an event. After the predicate procedure finds a match, copies the matched event into the client-supplied structure without removing the event from the queue. flushes the output buffer if it blocks waiting for additional events. See Also XAnyEvent(3X11), XNextEvent(3X11), XPutBackEvent(3X11) XSendEvent(3X11) X Window System: The Complete Reference, Second Edition, Robert W. Scheifler and James Gettys XIfEvent(3X11)