INSTAT function

Purpose

Determine whether a keyboard or mouse event is ready to be retrieved from the console input buffer.

Syntax

x = INSTAT

Remarks

The x variable receives the keyboard buffer status.  INSTAT return logical TRUE (non-zero) if a keyboard or mouse event is ready to be retrieved from the console input buffer, or FALSE (zero) if there are no events in the buffer.

INSTAT does not remove a keyboard or mouse event from the buffer.  So if INSTAT ever returns TRUE, it will always return TRUE until the event is removed from the buffer using INKEY$ or WAITKEY$.  Mouse support must be enabled in order to test for mouse events.

INSTAT is not subject to redirection.

See also

INKEY$, INSHIFT, MOUSE, WAITKEY$, WAITSTAT