NAME
irWait - wait for a voice event
SYNOPSIS
#include <irapi.h>
int irWait ( );
DESCRIPTION
The irWait function waits for an event to occur, then
returns. irWait is the event notification mechanism of the
IRAPI. Significant amounts of time, such as those introduce
through system calls, should not elapse between calls to
irWait.
The irCheck(3IRAPI) function is typically called after
irWait to obtain a description of the event.
EVENT
No event results from the call to irWait.
RETURN VALUE
IRR_OK is returned if an event occurred.
IRR_FAIL is returned if an error occurs.
ERROR
irError is set as follows if an error occurs:
IRER_SYSERROR if a system call failure occurs (check
irSysError for additional information)
IRER_NOREGISTER if the process has not been registered via a
call to irRegister(3IRAPI)
CAVEAT
The application must irWait soon after initiating one or
more asynchronous speech functions to ensure proper handling
of the system events at the driver level.
SEE ALSO
irCheck(3IRAPI), irSetEvent(3IRAPI), irWCheck(3IRAPI).
VERSION
This is version 11/25/02 of this man page.