_CONSOLEINPUT

From QB64 Phoenix Edition Wiki
Revision as of 04:24, 19 April 2022 by SMcNeill (talk | contribs) (Created page with "{{DISPLAYTITLE:_CONSOLEINPUT}} The _CONSOLEINPUT function is used to monitor any new mouse or keyboard input coming from a $CONSOLE window. It must be called in order for _CINP to return valid values. Windows-only. {{PageSyntax}} :{{Parameter|infoExists%%}} = _CONSOLEINPUT {{PageDescription}} * Returns 1 if new keyboard information is available, 2 if mouse information is available, otherwise it returns 0. * Must be called before reading any of the other m...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

The _CONSOLEINPUT function is used to monitor any new mouse or keyboard input coming from a $CONSOLE window. It must be called in order for _CINP to return valid values. Windows-only.


Syntax

infoExists%% = _CONSOLEINPUT


Description

  • Returns 1 if new keyboard information is available, 2 if mouse information is available, otherwise it returns 0.
  • Must be called before reading any of the other mouse functions and before reading _CINP.
  • To clear all previous input data, read _CONSOLEINPUT in a loop until it returns 0.
  • Not available in Linux or macOS.


Examples

Example 1: Reading individual key strokes from a console window (Windows).

  
$CONSOLE:ONLY
_DEST _CONSOLE: _SOURCE _CONSOLE

PRINT "Press any key, and I'll give you the scan code for it.  <ESC> quits the demo."
PRINT
PRINT
DO
    x = _CONSOLEINPUT
    IF x = 1 THEN 'read only keyboard input ( = 1)
        c = _CINP
        PRINT c;
    END IF
LOOP UNTIL c = 1
END


See also



Navigation:
Main Page with Articles and Tutorials
Keyword Reference - Alphabetical
Keyword Reference - By usage
Report a broken link