MouGetEventMask: Difference between revisions

Latest revision as of 22:32, 11 December 2019

Returns the current value of the mouse-event queue mask.

Syntax

MouGetEventMask(EventMask, DeviceHandle)

Parameters

EventMask (PULONG) - input: Event mask word.; Address in application storage where the event mask of the current mouse device driver is returned to the caller by the mouse device driver.; The EventMask is set by MouSetEventMask and has the following definition:

Bit	Description
31-7	Reserved. Set to 0.
6	Report button-3 press/release events, without mouse motion.
5	Report button-3 press/release events, with mouse motion.
4	Report button-2 press/release events, without mouse motion.
3	Report button-2 press/release events, with mouse motion.
2	Report button-1 press/release events, without mouse motion.
1	Report button-1 press/release events, with mouse motion.
0	Report mouse motion events with no button press/release events.

DeviceHandle (HMOU) - input: Mouse device handle.; Reserved. Set to 0.

Return Code

rc (APIRET) - returns: MouGetEventMask returns one of the following values:

0 NO_ERROR
466 ERROR_MOU_DETACHED
501 ERROR_MOUSE_NO_CONSOLE

@@ Line 1: / Line 1: @@
-==Description==
 Returns the current value of the mouse-event queue mask.
 ==Syntax==
-<PRE>
+ MouGetEventMask(EventMask, DeviceHandle)
-#define INCL_MOU
-#include <os2.h>
-PULONG    EventMask;     /*  Event mask word. */
-HMOU      DeviceHandle;  /*  Mouse device handle. */
-APIRET    rc;            /*  Return code. */
-rc = MouGetEventMask(EventMask, DeviceHandle);
-</PRE>
 ==Parameters==
-;  EventMask (PULONG) - input : Event mask word.
+;EventMask (PULONG) - input: Event mask word.
+:Address in application storage where the event mask of the current mouse device driver is returned to the caller by the mouse device driver.
-Address in application storage where the event mask of the current mouse device driver is returned to the caller by the mouse device driver.
+:The EventMask is set by [[MouSetEventMask]] and has the following definition:
+::{|class="wikitable"
-The EventMask is set by MouSetEventMask and has the following definition:
+!Bit||Description
+|-
-   Bit            Description
+|31-7||Reserved. Set to 0.
--7            Reserved. Set to 0.
+|-
-           Report button-3 press/release events, without mouse motion.
+|6||Report button-3 press/release events, without mouse motion.
-           Report button-3 press/release events, with mouse motion.
+|-
-           Report button-2 press/release events, without mouse motion.
+|5||Report button-3 press/release events, with mouse motion.
-           Report button-2 press/release events, with mouse motion.
+|-
-           Report button-1 press/release events, without mouse motion.
+|4||Report button-2 press/release events, without mouse motion.
-           Report button-1 press/release events, with mouse motion.
+|-
-           Report mouse motion events with no button press/release events.
+|3||Report button-2 press/release events, with mouse motion.
+|-
-; DeviceHandle (HMOU) - input : Mouse device handle.
+|2||Report button-1 press/release events, without mouse motion.
-Reserved. Set to 0.
+|-
+|1||Report button-1 press/release events, with mouse motion.
+|-
+|0||Report mouse motion events with no button press/release events.
+|}
+;DeviceHandle (HMOU) - input: Mouse device handle.
+:Reserved. Set to 0.
 ==Return Code==
- rc (APIRET) - returns
+;rc (APIRET) - returns:MouGetEventMask returns one of the following values:
+*0 NO_ERROR
-MouGetEventMask 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==
-*
-[[Category:The OS/2 API Project]]
+[[Category:Mou]]