* * HELP & MANUAL PREMIUM PACK 4 DEMO VERSION * *
This documentation was styled with a demo skin from the Premium Pack 4 add-on for Help & Manual. The contents of the skin are encrypted and not configurable. You can only publish HM projects with this skin. You cannot edit it or change it.
This version is copyright and may only be used for local testing purposes. It may not be distributed.
Please purchase the full version of the Premium Pack to get the configurable skins and remove this notice. The package will also include the Toolbox configuration utility for Premium Pack skins.
Description
Read a keyboard character or mouse event from the console input buffer.
Function will return immediately.
Syntax
s = Console_Inkey
Returns
String
Parameters
Name |
Type |
Optional |
Meaning |
None |
Remarks
Function will return different string length depending on event:
Len |
Meaning |
||||||||
0 |
Nothing in the input buffer |
||||||||
1 |
A standard keyboard key was pressed |
||||||||
2 |
An extended keyboard key was pressed. In this case the first char is zero, while the second is the extended keyboard code.
|
||||||||
3 |
A mouse event occurred. Right char will represent the mouse event while first and second char will report mouse position
|
Restrictions
If Console option "Quick Edit Mode" is active
See also
Examples
