MouGetNumButtons (OS/2 1.x): Difference between revisions
mNo edit summary |
mNo edit summary |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 2: | Line 2: | ||
==Syntax== | ==Syntax== | ||
MouGetNumButtons (NumberOfButtons, DeviceHandle) | MouGetNumButtons (NumberOfButtons, DeviceHandle) | ||
==Parameters== | ==Parameters== | ||
;NumberOfButtons (PUSHORT) - output : Address of the number of physical buttons. The return values for the number of buttons supported are: | ;NumberOfButtons (PUSHORT) - output : Address of the number of physical buttons. The return values for the number of buttons supported are: | ||
::1 - One mouse button | |||
::2 - Two mouse buttons | |||
::3 - Three mouse buttons. | |||
; DeviceHandle (HMOU) - input : Handle of the mouse device from a previous MouOpen. | ; DeviceHandle (HMOU) - input : Handle of the mouse device from a previous MouOpen. | ||
==Return Code== | ==Return Code== | ||
;rc (USHORT) - return:Return code descriptions are: | |||
Return code descriptions are: | *385 ERROR_MOUSE_NO_DEVICE | ||
* 385 | *466 ERROR_MOU_DETACHED | ||
* 466 | *501 ERROR_MOUSE_NO_CONSOLE | ||
* 501 | *505 ERROR_MOU_EXTENDED_SG | ||
* 505 | |||
== | ==Bindings== | ||
===C | ===C=== | ||
<PRE> | <PRE> | ||
#define INCL_MOU | #define INCL_MOU | ||
| Line 27: | Line 25: | ||
USHORT rc = MouGetNumButtons(NumberOfButtons, DeviceHandle); | USHORT rc = MouGetNumButtons(NumberOfButtons, DeviceHandle); | ||
PUSHORT | PUSHORT NumberOfButtons; /* Number of mouse buttons */ | ||
HMOU | HMOU DeviceHandle; /* Mouse device handle */ | ||
USHORT | USHORT rc; /* return code */ | ||
</PRE> | </PRE> | ||
===MASM | ===MASM=== | ||
<PRE> | <PRE> | ||
EXTRN MouGetNumButtons:FAR | EXTRN MouGetNumButtons:FAR | ||
| Line 44: | Line 42: | ||
Returns WORD | Returns WORD | ||
</PRE> | </PRE> | ||
== | |||
==Example== | |||
<code> | |||
HMOU DeviceHandle; | |||
... | |||
MouOpen(0L, &DeviceHandle); | |||
MouGetNumButtons(&NumberOfButtons, DeviceHandle); | |||
</code> | |||
[[Category:Mou]] | [[Category:Mou]] | ||
Latest revision as of 17:45, 14 September 2019
This call returns the number of buttons supported on the installed mouse driver.
Syntax
MouGetNumButtons (NumberOfButtons, DeviceHandle)
Parameters
- NumberOfButtons (PUSHORT) - output
- Address of the number of physical buttons. The return values for the number of buttons supported are:
- 1 - One mouse button
- 2 - Two mouse buttons
- 3 - Three mouse buttons.
- DeviceHandle (HMOU) - input
- Handle of the mouse device from a previous MouOpen.
Return Code
- rc (USHORT) - return
- Return code descriptions are:
- 385 ERROR_MOUSE_NO_DEVICE
- 466 ERROR_MOU_DETACHED
- 501 ERROR_MOUSE_NO_CONSOLE
- 505 ERROR_MOU_EXTENDED_SG
Bindings
C
#define INCL_MOU USHORT rc = MouGetNumButtons(NumberOfButtons, DeviceHandle); PUSHORT NumberOfButtons; /* Number of mouse buttons */ HMOU DeviceHandle; /* Mouse device handle */ USHORT rc; /* return code */
MASM
EXTRN MouGetNumButtons:FAR INCL_MOU EQU 1 PUSH@ WORD NumberOfButtons ;Number of mouse buttons PUSH WORD DeviceHandle ;Mouse device handle CALL MouGetNumButtons Returns WORD
Example
HMOU DeviceHandle;
...
MouOpen(0L, &DeviceHandle);
MouGetNumButtons(&NumberOfButtons, DeviceHandle);