en:docs:fapi:kbdflushbuffer

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

en:docs:fapi:kbdflushbuffer [2018/08/31 16:57] (current)
prokushev created
Line 1: Line 1:
 +==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)]]
 +
 +{{page>​en:​templates:​fapi}}
  

en/docs/fapi/kbdflushbuffer.txt · Last modified: 2018/08/31 16:57 by prokushev