KbdFlushBuffer (FAPI): Difference between revisions

Revision as of 22:56, 13 January 2017

This call clears the keystroke buffer.

KbdFlushBuffer (KbdHandle)

rc (USHORT) - return

Return code descriptions are:

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

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

#define INCL_KBD

USHORT  rc = KbdFlushBuffer(KbdHandle);

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

EXTRN  KbdFlushBuffer:FAR
INCL_KBD            EQU 1

PUSH   WORD    KbdHandle     ;Keyboard handle
CALL   KbdFlushBuffer

Returns WORD

@@ Line 3: / Line 3: @@
 ==Syntax==
-<PRE>
+  KbdFlushBuffer (KbdHandle)
-  KbdFlushBuffer
-    (KbdHandle)
-</PRE>
 ==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
@@ Line 26: / Line 23: @@
 ===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.
@@ Line 36: / Line 32: @@
 USHORT  rc = KbdFlushBuffer(KbdHandle);
-HKBD             KbdHandle;     /* Keyboard handle */
+HKBD    KbdHandle;     /* Keyboard handle */
+USHORT  rc;            /* return code */
-USHORT           rc;            /* return code */
 </PRE>
@@ Line 51: / Line 46: @@
 Returns WORD
 </PRE>
-==Related Functions==
-*
-[[Category:The OS/2 API Project]]
+[[Category:Kbd]]