* * 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, waiting until one is ready
Syntax
sBuffer = Canvas_Waitkey([AsciiKey [, ExtendedAsciiKey]])
Returns
String
A null string (LEN=0) means that there was an error, such as the case when no Canvas target has been assigned with Canvas_Attach.
A string length of one means that an ASCII key was pressed and the string contains the ASCII character. An ASCII value between 1 and 31 indicate a control code.
A string length of two means that an extended key was pressed. In this case, the first character in the string has an ASCII value of zero, and the second is the extended keyboard code.
Parameters
Name |
Type |
Optional |
Meaning |
AsciiKey |
Number |
Yes |
|
ExtendedAsciiKey |
Number |
Yes |
Remarks
Without any parameter:
Waits for a key to be pressed. It removes the character from the keyboard buffer for the selected Canvas target.
It returns a of 0, 1, or 2 characters that reflects the status of the keyboard buffer for the selected Canvas target.
Only with AsciiKey parameter:
Waits for a key to be pressed. The pressed Ascii Key is than compared with AsciiKey.
Command will return only if pressed key is equal to AsciiKey.
Example:
'---Wait till ESC key will be pressed
Canvas_WaitKey(27)
With ExtendedAsciiKey:
Always indicate 0 (zero) for AsciiKey and in ExtendedAsciiKey the number of the extended keyboard key to wait for.
Example:
'---Wait till F1 key will be pressed
Canvas_WaitKey(0, 59)
Restrictions
See also
Examples
