APeekEvent(3X)

NAME

APeekEvent − return but do not dequeue first event in audio event queue

SYNOPSIS

void
APeekEvent (

Audio ∗ audio,

AEvent ∗ event_return,

long ∗ status_return);

DESCRIPTION

APeekEvent() returns, but does not dequeue, the first event in the audio event queue. If no match is found, this function blocks until a matching event is received. This behavior is unlike ACheckEvent(), ACheckMaskEvent(), and ANextEvent(), which dequeue an event from the queue when they return it, and ACheckEvent(), and ACheckMaskEvent(), which do not block if there is no event or matching event, respectively.

audio specifies the Audio structure associated with this connection.

event_return is the first event in the audio event queue.

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

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 the event copy and status_return to receive an error status.

Audio ∗ audio; /∗ audio connection ∗/

AEvent event_return; /∗ event_return ∗/

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

/∗ copy first event on queue ∗/

APeekEvent(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

APeekEvent() was developed by HP.

Museum

Related Articles