NAME

AEventsQueued − get number of events in queue for specified server connection

SYNOPSIS

#include <audio/Alib.h>

long AEventsQueued (

Audio *audio, AQueueCheckMode mode,

long *status_return

);

DESCRIPTION

AEventsQueued() returns the number of events in the queue for the specified audio server, depending on mode.

audio specifies the Audio structure associated with this connection. 

mode is AQueuedAlready or AQueuedAfterReading. 

If the mode is AQueuedAlready, the call returns the number of events in the queue including zero.  If the mode is AQueuedAfterReading and there are no events on the queue, the function tries to determine whether the server has more events for this connection, and returns the number it finds.  If there are none, it returns zero. 

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

RETURN VALUE

Upon successful completion, AEventsQueued() returns the number of events in the queue for the specified server connection, depending upon the mode.

ERRORS

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

0 AENoError

2 AEBadAudio

3 AEBadValue

EXAMPLES

The following example gets the number of events on the queue for the audio server connection specified by audio and sets up status to receive an error status.  The mode is set to AQueuedAlready so that the call will return zero if there are no events in the queue. 

long e_num;             /* number of events in q */
Audio *audio;           /* audio connection */
AQueueCheckMode mode;   /* check mode */
long status; /* error status */"
.
.
.
/* check event queue */
mode = AQueuedAlready;
e_num = AEventsQueued(audio, mode, &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

AEventsQueued() was developed by HP. 

SEE ALSO

ACheckEvent(3X) ACheckMaskEvent(3X), AMaskEvent(3X), ANextEvent(3X), APeekEvent(3X), APutBackEvent(3X), AQLength(3X), ASelectInput(3X). 

Using the Audio Application Program Interface.

Hewlett-Packard Company  —  HP-UX Release 9.10: April 1995