ACheckEvent(3X)

NAME

ACheckEvent − get first event found in audio event queue

SYNOPSIS

Boolean
ACheckEvent (

Audio ∗ audio,

AEvent ∗ event_return,

long ∗ status_return);

DESCRIPTION

ACheckEvent() dequeues and returns the first event in the queue and returns TRUE. If the queue is empty, the function returns FALSE immediately. This behavior contrasts with APeekEvent() , which finds but does not dequeue the first event on the queue, and which blocks, if the queue is empty, until an event is received.

audio specifies the Audio structure associated with this connection.

event_return is the first event found in the queue.

status_return receives the returned status of the operation, unless it is set to NULL.

RETURN VALUE

Upon successful completion, ACheckEvent() returns TRUE or FALSE.

ERRORS

If status_return is not set to NULL, one of the following is returned in status_return:

0 AENoError

2 AEBadAudio

EXAMPLE

The following example sets up event to receive event data and status_return to receive status data.

Boolean first_event; /∗ first event on queue ∗/

Audio ∗ audio; /∗ audio connection ∗/

AEvent event_return; /∗ event_return ∗/

long status; /∗ error status ∗/
.
.
.

/∗ check event queue ∗/

first_event = ACheckEvent(audio, &event_return, &status);

DEPENDENCIES

This function belongs to the Audio Library of functions that manage connections to an audio server. The audio server must run on a system that has audio hardware. To find out whether or not your system has audio hardware, refer to the hardware manual that accompanies your system.

AUTHOR

ACheckEvent() was developed by HP.

Museum

Related Articles