MOUSESTAT function

Purpose

Determine if a mouse event is waiting to be retrieved from the console input buffer.

Syntax

x& = MOUSESTAT

Remarks

Unlike INSTAT, MOUSESTAT only returns TRUE (non-zero) if a defined mouse event has occurred.  It does not report keyboard events occurred, and MOUSESTAT does not remove any keyboard or mouse events from the buffer.

Once MOUSESTAT returns TRUE, it will continue to return TRUE until all mouse events are removed from the buffer using INKEY$ or WAITKEY$.

Restrictions

Mouse support must be enabled in order to test for mouse events.

See also

INKEY$, INSHIFT, MOUSE, WAITKEY$, WAITSTAT