KbdPeek

From EDM2
Jump to: navigation, search

Returns a keyboard-character data record, if available, but does not remove it from the queue.

Syntax

KbdPeek (CharData, hkbd)

Parameters

CharData (PKBDKEYINFO) - output 
Pointer to character data.
A pointer to a KBDKEYINFO structure in which the character data is returned.
hkbd (HKBD) - input 
Reserved. Must be 0.

Return Code

rc (APIRET) - returns

KbdPeek returns one of the following values:

  • 0 NO_ERROR
  • 375 ERROR_KDB_INVALID_IOWAIT
  • 439 ERROR_KBD_INVALID_HANDLE
  • 445 ERROR_KBD_FOCUS_REQUIRED
  • 447 ERROR_KBD_KEYBOARD_BUSY
  • 504 ERROR_KBD_EXTENDED_SG

Remarks

Note: KbdPeek returns a complete keystroke. This behavior is unlike the OS/2 1.3 version, which returned only a single byte. This is significant only for DBCS characters.

If bit 0 of fbStatus is set, the character returned is either 0 or 0xe0. The Unicode character contains the virtual key.

For valid characters, the character in the current code page is returned, and the Unicode character contains the Unicode encoding of the character.