en:docs:fapi:mougeteventmask

Differences

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

Link to this comparison view

Next revision		Previous revision
en:docs:fapi:mougeteventmask [2021/10/06 14:25] – created prokusheven:docs:fapi:mougeteventmask [2021/11/04 13:13] (current) – prokushev
Line 1: Line 1:
 +{{page>en:templates:fapiint}}
 +
 +====== MouGetEventMask ======
 +
 This call returns the current value of the mouse event queue mask. This call returns the current value of the mouse event queue mask.
  
-==Syntax==+===== Syntax ===== 
 +<code c>
  MouGetEventMask (EventMask, DeviceHandle)  MouGetEventMask (EventMask, DeviceHandle)
 +</code>
  
-==Parameters== +===== Parameters =====
-;EventMask (PUSHORT) - output : Address in application storage where the current mouse device driver's event mask is returned to the caller by the mouse device driver. +
-:The EventMask is set by MouSetEventMask, and has the following definition: +
-::{|class="wikitable" +
-!Bit||Description +
-|- +
-|15-7||Reserved, set to zero. +
-|- +
-|6||Set to report button 3 press/release events, without mouse motion. +
-|- +
-|5||Set to report button 3 press/release events, with mouse motion. +
-|- +
-|4||Set to report button 2 press/release events, without mouse motion. +
-|- +
-|3||Set to report button 2 press/release events, with mouse motion. +
-|- +
-|2||Set to report button 1 press/release events, without mouse motion. +
-|- +
-|1||Set to report button 1 press/release events, with mouse motion. +
-|- +
-|0||Set to report mouse motion events with no button press/release events. +
-|} +
-;DeviceHandle (HMOU) - input: Handle of the mouse device from a previous MouOpen.+
  
-==Return Code== +  * EventMask (PUSHORT) - output : Address in application storage where the current mouse device driver's event mask is returned to the caller by the mouse device driver. 
-;rc (USHORT) - return:Return code descriptions are: + 
-*0 NO_ERROR +The EventMask is set by MouSetEventMask, and has the following definition: 
-*385 ERROR_MOUSE_NO_DEVICE + 
-*466 ERROR_MOU_DETACHED +^ Bit ^ Description ^ 
-*501 ERROR_MOUSE_NO_CONSOLE +|15-7|Reserved, set to zero.| 
-*505 ERROR_MOU_EXTENDED_SG+|6|Set to report button 3 press/release events, without mouse motion.| 
 +|5|Set to report button 3 press/release events, with mouse motion.| 
 +|4|Set to report button 2 press/release events, without mouse motion.| 
 +|3|Set to report button 2 press/release events, with mouse motion.| 
 +|2|Set to report button 1 press/release events, without mouse motion.| 
 +|1|Set to report button 1 press/release events, with mouse motion.| 
 +|0|Set to report mouse motion events with no button press/release events.| 
 + 
 +  * DeviceHandle (HMOU) - input: Handle of the mouse device from a previous MouOpen. 
 + 
 +===== Return Code ===== 
 + 
 +rc (USHORT) - return:Return code descriptions are: 
 + 
 +  *0 NO_ERROR 
 +  *385 ERROR_MOUSE_NO_DEVICE 
 +  *466 ERROR_MOU_DETACHED 
 +  *501 ERROR_MOUSE_NO_CONSOLE 
 +  *505 ERROR_MOU_EXTENDED_SG 
 + 
 +===== Remarks =====
  
-==Remarks== 
 Buttons are logically numbered from left to right. Buttons are logically numbered from left to right.
  
-==Bindings== +===== Bindings ===== 
-=== C === + 
-<PRE>+==== C ==== 
 +<code c>
 #define INCL_MOU #define INCL_MOU
  
Line 50: Line 54:
  
 USHORT  rc;            /* return code */ USHORT  rc;            /* return code */
-</PRE>+</code>
  
-===MASM=== +====MASM==== 
-<PRE>+<code asm>
 EXTRN  MouGetEventMask:FAR EXTRN  MouGetEventMask:FAR
 INCL_MOU            EQU 1 INCL_MOU            EQU 1
Line 62: Line 66:
  
 Returns WORD Returns WORD
-</PRE>+</code>
  
-[[Category:Mou]]+{{page>en:templates:fapi}}