ConMouseStat function

 

Usage:

Boolean& = ConMouseStat

 

Legacy Syntax:

Boolean& = MOUSESTAT

 

Pseudo-object Syntax:

Boolean& = CON.MOUSE.STAT

 

Determines whether a mouse event is ready to be retrieved from the console input buffer.

 

Returns a logical TRUE value (non-zero) if a defined mouse event is available, or FALSE (zero) if no events are ready. If no mouse reports are enabled, FALSE is always returned.

 

ConMouseStat does not remove any keyboard or mouse events from the buffer. So, if it returns TRUE, it will continue to return TRUE until all pending mouse events are removed using ConInKey$ or ConWaitKey$.

 

Conversion:

 

#IF %DEF(%PB_CC32)

  Boolean& = MOUSESTAT

#ELSE

  Boolean& = ConMouseStat

#ENDIF

 

CON.MOUSE.STAT or CONSOLE.MOUSE.STAT may be substituted for MOUSESTAT in programs written for PB/CC 6. The syntax " ... TO Boolean&" may be used instead of "Boolean& = ..."

 

See Also: ConMouse, ConInKey$, ConWaitKey$