en:docs:fapi:mougeteventmask

This is an old revision of the document!


This call returns the current value of the mouse event queue mask.

Syntax

MouGetEventMask (EventMask, DeviceHandle)

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
6
5
4
3
2
1
0

;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

Buttons are logically numbered from left to right.

Bindings

C

<PRE> #define INCL_MOU

USHORT rc = MouGetEventMask(EventMask, DeviceHandle);

PUSHORT EventMask; /* Event Mask word */ HMOU DeviceHandle; /* Mouse device handle */

USHORT rc; /* return code */ </PRE>

MASM

<PRE> EXTRN MouGetEventMask:FAR INCL_MOU EQU 1

PUSH@ WORD EventMask ;Event Mask word PUSH WORD DeviceHandle ;Mouse device handle CALL MouGetEventMask

Returns WORD </PRE>

Mou