This is an old revision of the document!
This is part of Family API which allow to create dual-os version of program runs under OS/2 and DOS
Note: This is legacy API call. It is recommended to use 32-bit equivalent
KbdFlushBuffer
Description
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.
Example Code
C Binding
<PRE> #define INCL_KBD
USHORT rc = KbdFlushBuffer(KbdHandle);
HKBD KbdHandle; /* Keyboard handle */ USHORT rc; /* return code */ </PRE>
MASM Binding
<PRE> EXTRN KbdFlushBuffer:FAR INCL_KBD EQU 1
PUSH WORD KbdHandle ;Keyboard handle CALL KbdFlushBuffer
Returns WORD </PRE>
Note
Text based on http://www.edm2.com/index.php/KbdFlushBuffer_(FAPI)