AEventsQueued(3X)

NAME

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

SYNOPSIS

#include <Alib.h> long
AEventsQueued (

Audio ∗ audio,

AQueueCheckMode mode,

long ∗ status_return );

DESCRIPTION

audio specifies the Audio structure associated with this connection.

mode One of the following values:

AQueuedAlready − return the number of events in the queue.

AQueuedAfterReading − if there are no events in the queue, the Audio library tries to ascertain if 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 this parameter is passed in as a NULL pointer. If status_return is set to NULL, Alib will do the error handling.

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, it can return one of the following values:

0 AENoError No error - the call completed successfully.

2 AEBadAudio The audio structure is invalid. A pointer to a valid audio structure may be missing (use AOpenAudio() to get a valid pointer).

3 AEBadValue The mode parameter contains an incorrect value.

17 AEOutofMemory The Audio Library tried to allocate space but failed.

EXAMPLE

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 queue ∗/

Audio ∗ audio; /∗ audio connection ∗/

AQueueCheckMode mode; /∗ check mode ∗/

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

/∗ check event queue ∗/

mode = AQueuedAlready;

e_num = AEventsQueued(audio, mode, &status);

NOTE

In order to ensure that the compiler finds the Audio Library (libAlib.sl) and the Alib.h header file, you must add the following switches:

-L /opt/audio/lib
-I/opt/audio/include

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 Using the Audio Developer’s Kit or the online help for the Audio control panel. For information about the audio capabilities of a particular system use the online example audioinfo.c.

AUTHOR

AEventsQueued() was developed by HP.

Museum

Related Articles