MouFlushQue: Difference between revisions

Latest revision as of 23:50, 11 December 2019

Directs the mouse device driver to empty the mouse-event queue.

MouFlushQue(DeviceHandle)

DeviceHandle (HMOU) - input

Mouse device handle.

Reserved. Must be 0.

rc (APIRET) - returns

Return code.

MouFlushQue returns one of the following values:

0 NO_ERROR

466 ERROR_MOU_DETACHED

501 ERROR_MOUSE_NO_CONSOLE

@@ Line 1: / Line 1: @@
-==Description==
 Directs the mouse device driver to empty the mouse-event queue.
 ==Syntax==
-<PRE>
+ MouFlushQue(DeviceHandle)
-#define INCL_MOU
-#include <os2.h>
-HMOU      DeviceHandle;  /*  Mouse device handle. */
-APIRET    rc;            /*  Return code. */
-rc = MouFlushQue(DeviceHandle);
-</PRE>
 ==Parameters==
-; DeviceHandle (HMOU) - input : Mouse device handle.
+;DeviceHandle (HMOU) - input: Mouse device handle.
-Reserved. Must be 0.
+:Reserved. Must be 0.
-==Return Code==
+;rc (APIRET) - returns:Return code.
- rc (APIRET) - returns
+:MouFlushQue returns one of the following values:
+::0 NO_ERROR
-MouFlushQue returns one of the following values:
+::466 ERROR_MOU_DETACHED
+::501 ERROR_MOUSE_NO_CONSOLE
-* 0        NO_ERROR
-* 466      ERROR_MOU_DETACHED
-* 501      ERROR_MOUSE_NO_CONSOLE
-==Remarks==
-==Example Code==
-<PRE>
-</PRE>
-==Related Functions==
-* [[OS2 API:CPI:
-[[Category:The OS/2 API Project]]
+[[Category:Mou]]