KbdPeek: Difference between revisions

Latest revision as of 18:15, 6 January 2023

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.

@@ Line 1: / Line 1: @@
-==Description==
 Returns a keyboard-character data record, if available, but does not remove it from the queue.
 ==Syntax==
-<PRE>
+  KbdPeek (CharData, hkbd)
-#define INCL_KBD
-#include <os2.h>
-PKBDKEYINFO    CharData;  /*  Pointer to character data. */
-HKBD           hkbd;      /*  Reserved.  Must be 0. */
-APIRET         rc;        /*  Return code. */
-rc = KbdPeek(CharData, hkbd);
-</PRE>
 ==Parameters==
 ;CharData (PKBDKEYINFO) - output : Pointer to character data.
-A pointer to a KBDKEYINFO structure in which the character data is returned.
+:A pointer to a KBDKEYINFO structure in which the character data is returned.
-; hkbd (HKBD) - input : Reserved. Must be 0.
+;hkbd (HKBD) - input : Reserved. Must be 0.
 ==Return Code==
- rc (APIRET) - returns
+;rc (APIRET) - returns:KbdPeek returns one of the following values:
-KbdPeek returns one of the following values:
+*0 NO_ERROR
-* 0          NO_ERROR
+*375 ERROR_KDB_INVALID_IOWAIT
-* 375        ERROR_KDB_INVALID_IOWAIT
+*439 ERROR_KBD_INVALID_HANDLE
-* 439        ERROR_KBD_INVALID_HANDLE
+*445 ERROR_KBD_FOCUS_REQUIRED
-* 445        ERROR_KBD_FOCUS_REQUIRED
+*447 ERROR_KBD_KEYBOARD_BUSY
-* 447        ERROR_KBD_KEYBOARD_BUSY
+*504 ERROR_KBD_EXTENDED_SG
-* 504        ERROR_KBD_EXTENDED_SG
 ==Remarks==
@@ Line 34: / Line 23: @@
 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.
 [[Category:Kbd]]