NAME
irFlushInput - remove all characters from the input queue
SYNOPSIS
#include <irapi.h>
int irFlushInput (channel_id cid);
DESCRIPTION
The irFlushInput function removes all characters from the
input queue for the specified channel. Since input charac-
ters are always being collected, irGetInput(3IRAPI) might
retrieve unwanted characters left in the input queue.
irFlushInput can be used to prevent dial-ahead. The applica-
tion starts collecting input characters at a known point in
time (that is, when irFlushInput is called).
EVENT
No event results from the call to irFlushInput.
RETURN VALUE
The number of characters flushed is returned if irFlushInput
is successful.
IRR_FAIL is returned if an error occurs.
ERROR
irError is set as follows if an error occurs:
IRER_INVALID if the cid is invalid
IRER_SYSERROR if a system or driver call failure occurs (see
irSysError for additional information)
SEE ALSO
irGetInput(3IRAPI), irUngetInput
VERSION
This is version 8/31/00 of this man page.