MouGetNumButtons

From EDM2
Revision as of 13:27, 29 February 2020 by Martini (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Returns the number of buttons supported on the installed mouse device driver.

Syntax

MouGetNumButtons(NumberOfButtons, DeviceHandle);

Parameters

NumberOfButtons (PULONG) - output 
Number of mouse buttons.
Address where the number of physical buttons is to be returned.
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 
Mouse device handle.

Reserved. Set to 0.

Return Code

rc (APIRET) - returns

MouGetNumButtons returns one of the following values:

  • 0 NO_ERROR
  • 466 ERROR_MOU_DETACHED
  • 501 ERROR_MOUSE_NO_CONSOLE

Sample

#define INCL_MOU
#include <os2.h>

PULONG    NumberOfButtons;  /*  Number of mouse buttons. */
HMOU      DeviceHandle;     /*  Mouse device handle. */
APIRET    rc;               /*  Return code. */

rc = MouGetNumButtons(NumberOfButtons, DeviceHandle);