NAME

APutBackEvent − push event onto head of audio event queue

SYNOPSIS

#include <Alib.h> void
APutBackEvent (

Audio ∗  audio,

AEvent ∗  event,

long ∗  status_return );

DESCRIPTION

APutBackEvent() pushes event onto the head of the audio event queue for the server specified by audio. 

This routine can be useful if you read an event and then decide that you would rather deal with it later. 

audio specifies the Audio structure associated with this connection. 

event is the event to put on the queue. 

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. 

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). 

17  AEOutofMemory The Audio Library could not allocate space for the event. 

EXAMPLE

The following example puts event at the head of the audio event queue and sets up status to receive an error status. 

Audio ∗ audio;  /∗ audio connection ∗/

AEvent ∗ event;  /∗ event ∗/

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

/∗ put event at head of queue ∗/

event = event_return;  /∗ use event_return value from prior call ∗/
        /∗ such as ANextEvent() ∗/

APutBackEvent(audio, event, &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

APutBackEvent() was developed by HP. 

SEE ALSO

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

Hewlett-Packard Company  —  Audio Library: February, 1995