Jump to content

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

From EDM2
Ak120 (talk | contribs)
mNo edit summary
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:
 
  '''Value        Definition'''
  '''Value        Definition'''
  1        One mouse button
  1        One mouse button
  2        Two mouse buttons
  2        Two mouse buttons
  3        Three 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
  rc (USHORT) - return
Return code descriptions are:
Return code descriptions are:
* 385        ERROR_MOUSE_NO_DEVICE  
* 385        ERROR_MOUSE_NO_DEVICE  
* 466        ERROR_MOU_DETACHED  
* 466        ERROR_MOU_DETACHED  
* 501        ERROR_MOUSE_NO_CONSOLE  
* 501        ERROR_MOUSE_NO_CONSOLE  
* 505        ERROR_MOU_EXTENDED_SG
* 505        ERROR_MOU_EXTENDED_SG
==Remarks==


==Example Code==
==Example Code==
Line 59: Line 47:
*  
*  


[[Category:The OS/2 API Project]]
[[Category:Mou]]

Revision as of 00:46, 27 February 2017

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