MouGetNumButtons (OS/2 1.x)

Legacy Function Warning
It is recommended to use a newer replacement for this function.
Replacement:	MouGetNumButtons
Remarks:	This page list the older version of the function for reference.

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:

Value        Definition
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

Example Code

C Binding

#define INCL_MOU

USHORT  rc = MouGetNumButtons(NumberOfButtons, DeviceHandle);

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

USHORT           rc;               /* return code */

MASM Binding

EXTRN  MouGetNumButtons:FAR
INCL_MOU            EQU 1

PUSH@  WORD    NumberOfButtons ;Number of mouse buttons
PUSH   WORD    DeviceHandle    ;Mouse device handle
CALL   MouGetNumButtons

Returns WORD

Related Functions