KbdFlushBuffer (FAPI): Difference between revisions

Latest revision as of 14:39, 28 February 2020

This call clears the keystroke buffer.

Syntax

KbdFlushBuffer (KbdHandle)

Parameters

KbdHandle (HKBD) - input: Default keyboard or the logical keyboard.

Return Code

rc (USHORT) - return

Return code descriptions are:

0 NO_ERROR

439 ERROR_KBD_INVALID_HANDLE

445 ERROR_KBD_FOCUS_REQUIRED

447 ERROR_KBD_KEYBOARD_BUSY

464 ERROR_KBD_DETACHED

504 ERROR_KBD_EXTENDED_SG

Remarks

KbdFlushBuffer completes when the handle has access to the physical keyboard (focus), or is equal to zero and no other handle has the focus.

Family API Considerations

Some options operate differently in the DOS mode than in the OS/2 mode. The KbdHandle is ignored when coding in the DOS mode.

Bindings

C

#define INCL_KBD

USHORT  rc = KbdFlushBuffer(KbdHandle);

HKBD    KbdHandle;     /* Keyboard handle */
USHORT  rc;            /* return code */

MASM

EXTRN  KbdFlushBuffer:FAR
INCL_KBD            EQU 1

PUSH   WORD    KbdHandle     ;Keyboard handle
CALL   KbdFlushBuffer

Returns WORD

@@ Line 1: / Line 1: @@
-==Description==
 This call clears the keystroke buffer.
 ==Syntax==
-<PRE>
+  KbdFlushBuffer (KbdHandle)
-  KbdFlushBuffer
-    (KbdHandle)
-</PRE>
 ==Parameters==
-;  KbdHandle (HKBD) - input : Default keyboard or the logical keyboard.
+;KbdHandle (HKBD) - input: Default keyboard or the logical keyboard.
 ==Return Code==
- rc (USHORT) - return
+;rc (USHORT) - return:Return code descriptions are:
+::0 NO_ERROR
-Return code descriptions are:
+::439 ERROR_KBD_INVALID_HANDLE
+::445 ERROR_KBD_FOCUS_REQUIRED
-* 0          NO_ERROR
+::447 ERROR_KBD_KEYBOARD_BUSY
-* 439        ERROR_KBD_INVALID_HANDLE
+::464 ERROR_KBD_DETACHED
-* 445        ERROR_KBD_FOCUS_REQUIRED
+::504 ERROR_KBD_EXTENDED_SG
-* 447        ERROR_KBD_KEYBOARD_BUSY
-* 464        ERROR_KBD_DETACHED
-* 504        ERROR_KBD_EXTENDED_SG
 ==Remarks==
@@ Line 26: / Line 20: @@
 ===Family API Considerations===
+Some options operate differently in the DOS mode than in the OS/2 mode. The KbdHandle is ignored when coding in the DOS mode.
-Some options operate differently in the DOS mode than in the OS/2 mode. The KbdHandle is ignored when coding in the DOS mode.
+==Bindings==
+===C===
-==Example Code==
-===C Binding===
 <PRE>
 #define INCL_KBD
@@ Line 36: / Line 29: @@
 USHORT  rc = KbdFlushBuffer(KbdHandle);
-HKBD             KbdHandle;     /* Keyboard handle */
+HKBD    KbdHandle;     /* Keyboard handle */
+USHORT  rc;            /* return code */
-USHORT           rc;            /* return code */
 </PRE>
-===MASM Binding===
+===MASM===
 <PRE>
 EXTRN  KbdFlushBuffer:FAR
@@ Line 51: / Line 43: @@
 Returns WORD
 </PRE>
-==Related Functions==
-*
-[[Category:The OS/2 API Project]]
+[[Category:Kbd]]