en:docs:fapi:mouseteventmask

Differences

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

Link to this comparison view

Last revisionBoth sides next revision
en:docs:fapi:mouseteventmask [2021/10/06 14:28] – created prokusheven:docs:fapi:mouseteventmask [2021/10/15 06:12] – prokushev
Line 1: Line 1:
-{{Legacy +{{page>en:templates:fapiint}} 
-|RepFunc=[[MouSetEventMask]] + 
-|Remarks=This page list the older version of the function for reference. +====== MouSetEventMask ====== 
-}}+
 This call assigns a new event mask to the current mouse device driver. This call assigns a new event mask to the current mouse device driver.
  
-==Syntax==+===== Syntax ===== 
 +<code c>
  MouSetEventMask (EventMask, DeviceHandle)  MouSetEventMask (EventMask, DeviceHandle)
 +</code>
  
-==Parameters== +===== Parameters =====
-;EventMask (PUSHORT) - input : Address of a value in application storage used to indicate what mouse events are to be placed on the event queue (see MouReadEventQue) and which events are to be ignored. +
-:The EventMask bit values are described below: +
- '''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 mouse motion events with no button press/release events. +
-:A bit clear setting (set to zero) in an EventMask bit position indicates that the associated type of event is not reported to the application. Note also that the mouse buttons are always numbered from left to right. When the mouse is properly positioned for use, the left-hand button is button 1. +
-;DeviceHandle (HMOU) - input : Handle of the mouse device from a previous MouOpen.+
  
-==Return Code== +  * EventMask (PUSHORT) - input : Address of a value in application storage used to indicate what mouse events are to be placed on the event queue (see MouReadEventQue) and which events are to be ignored. 
-;rc (USHORT) - return:Return code descriptions are: + 
-* 0   NO_ERROR +The EventMask bit values are described below: 
-* 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 mouse motion events with no button press/release events. | 
 + 
 +A bit clear setting (set to zero) in an EventMask bit position indicates that the associated type of event is not reported to the application. Note also that the mouse buttons are always numbered from left to right. When the mouse is properly positioned for use, the left-hand button is button 1. 
 + 
 +  * 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== 
 Setting a bit in the event mask means that the associated event is reported on the mouse FIFO event queue. See MouReadEventQue for examples of event mask use. Setting a bit in the event mask means that the associated event is reported on the mouse FIFO event queue. See MouReadEventQue for examples of event mask use.
  
-==Bindings== +===== Bindings ===== 
-=== C === + 
-<PRE>+==== C ==== 
 +<code c>
 #define INCL_MOU #define INCL_MOU
  
Line 45: Line 56:
  
 USHORT  rc;            /* return code */ USHORT  rc;            /* return code */
-</PRE>+</code>
  
-===MASM=== +====MASM==== 
-<PRE>+<code asm>
 EXTRN  MouSetEventMask:FAR EXTRN  MouSetEventMask:FAR
 INCL_MOU            EQU 1 INCL_MOU            EQU 1
Line 57: Line 68:
  
 Returns WORD Returns WORD
-</PRE>+</code> 
  
-[[Category:Mou]]