Jump to content

MouGetNumButtons (OS/2 1.x): Difference between revisions

From EDM2
Created page with "==Description== This call returns the number of buttons supported on the installed mouse driver. ==Syntax== <PRE> MouGetNumButtons (NumberOfButtons, DeviceHandle) </PR..."
 
Ak120 (talk | contribs)
35,883 edits
mNo edit summary
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
==Description==
This call returns the number of buttons supported on the installed mouse driver.
This call returns the number of buttons supported on the installed mouse driver.


==Syntax==
==Syntax==
<PRE>
  MouGetNumButtons (NumberOfButtons, DeviceHandle)
  MouGetNumButtons


    (NumberOfButtons, DeviceHandle)
</PRE>
==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
'''Value        Definition'''
::2 - Two mouse buttons
1       One mouse button
::3 - Three mouse buttons.
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:
*385 ERROR_MOUSE_NO_DEVICE
*466 ERROR_MOU_DETACHED
*501 ERROR_MOUSE_NO_CONSOLE
*505 ERROR_MOU_EXTENDED_SG


rc (USHORT) - return
==Bindings==
 
===C===
Return code descriptions are:
 
* 385        ERROR_MOUSE_NO_DEVICE
* 466        ERROR_MOU_DETACHED
* 501        ERROR_MOUSE_NO_CONSOLE
* 505        ERROR_MOU_EXTENDED_SG
 
==Remarks==
 
 
==Example Code==
===C Binding===
<PRE>
<PRE>
#define INCL_MOU
#define INCL_MOU
Line 39: Line 25:
USHORT  rc = MouGetNumButtons(NumberOfButtons, DeviceHandle);
USHORT  rc = MouGetNumButtons(NumberOfButtons, DeviceHandle);


PUSHORT         NumberOfButtons;  /* Number of mouse buttons */
PUSHORT NumberOfButtons;  /* Number of mouse buttons */
HMOU             DeviceHandle;    /* Mouse device handle */
HMOU   DeviceHandle;    /* Mouse device handle */


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


===MASM Binding===
===MASM===
<PRE>
<PRE>
EXTRN  MouGetNumButtons:FAR
EXTRN  MouGetNumButtons:FAR
Line 56: Line 42:
Returns WORD
Returns WORD
</PRE>
</PRE>
==Related Functions==
* [[OS2 API:CPI:


==Example==
<code>
HMOU DeviceHandle;
...
MouOpen(0L, &DeviceHandle);
MouGetNumButtons(&NumberOfButtons, DeviceHandle);
</code>


[[Category:The OS/2 API Project]]
[[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);

Retrieved from "https://www.edm2.com/index.php?title=MouGetNumButtons_(OS/2_1.x)&oldid=63912"