MouSetDevStatus (OS/2 1.x): Difference between revisions
m Ak120 moved page OS2 API:CPI:LEGACY:MouSetDevStatus to MouSetDevStatus (OS/2 1.x) |
mNo edit summary |
||
| Line 1: | Line 1: | ||
This call sets the mouse device driver status flags for the installed mouse device driver. | This call sets the mouse device driver status flags for the installed mouse device driver. | ||
==Syntax== | ==Syntax== | ||
MouSetDevStatus (DeviceStatus, DeviceHandle) | |||
MouSetDevStatus | |||
==Parameters== | ==Parameters== | ||
; | ;DeviceStatus (PUSHORT) - input : Address of the desired status flag settings. | ||
:The passed parameter is a 2-byte set of flags. Only the high-order byte has meaning. | |||
The passed parameter is a 2-byte set of flags. Only the high-order byte has meaning. | |||
'''Bit Description''' | '''Bit Description''' | ||
15-10 Reserved, set to zero. | 15-10 Reserved, set to zero. | ||
9 Set if mouse device is to return data in mickeys. | 9 Set if mouse device is to return data in mickeys. | ||
8 Set if the drawing operations for the pointer draw routine are to be disabled. | 8 Set if the drawing operations for the pointer draw routine are to be disabled. | ||
7-0 Reserved, set to zero. | 7-0 Reserved, set to zero. | ||
; 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: | ||
* 0 NO_ERROR | * 0 NO_ERROR | ||
* 385 ERROR_MOUSE_NO_DEVICE | * 385 ERROR_MOUSE_NO_DEVICE | ||
| Line 35: | Line 26: | ||
==Remarks== | ==Remarks== | ||
MouSetDevStatus is the complement to MouGetDevStatus. However, not all status flags may be set with MouSetDevStatus. Only the flags corresponding to the following functions may be modified: | MouSetDevStatus is the complement to MouGetDevStatus. However, not all status flags may be set with MouSetDevStatus. Only the flags corresponding to the following functions may be modified: | ||
* Return data in mickeys. | * Return data in mickeys. | ||
*:Normally, mouse data is returned to the application with the absolute display mode coordinates of the pointer image position on the display screen. By setting this status flag, mouse data is returned in relative mickeys, a unit of mouse movement. | |||
Normally, mouse data is returned to the application with the absolute display mode coordinates of the pointer image position on the display screen. By setting this status flag, mouse data is returned in relative mickeys, a unit of mouse movement. | |||
* Don't call pointer draw device. | * Don't call pointer draw device. | ||
*:Normally, the pointer draw device driver is called for all drawing operations. By setting this status flag, the mouse device driver does not call the pointer draw device driver. The application must draw any required pointer image on the screen. | |||
Normally, the pointer draw device driver is called for all drawing operations. By setting this status flag, the mouse device driver does not call the pointer draw device driver. The application must draw any required pointer image on the screen. | |||
==Example Code== | ==Example Code== | ||
| Line 69: | Line 55: | ||
Returns WORD | Returns WORD | ||
</PRE> | </PRE> | ||
[[Category: | [[Category:Mou]] | ||
Revision as of 00:38, 7 March 2017
This call sets the mouse device driver status flags for the installed mouse device driver.
Syntax
MouSetDevStatus (DeviceStatus, DeviceHandle)
Parameters
- DeviceStatus (PUSHORT) - input
- Address of the desired status flag settings.
- The passed parameter is a 2-byte set of flags. Only the high-order byte has meaning.
Bit Description 15-10 Reserved, set to zero. 9 Set if mouse device is to return data in mickeys. 8 Set if the drawing operations for the pointer draw routine are to be disabled. 7-0 Reserved, set to zero.
- DeviceHandle (HMOU) - input
- Handle of the mouse device from a previous MouOpen.
Return Code
rc (USHORT) - return
Return code descriptions are:
- 0 NO_ERROR
- 385 ERROR_MOUSE_NO_DEVICE
- 387 ERROR_MOUSE_INV_PARMS
- 466 ERROR_MOU_DETACHED
- 501 ERROR_MOUSE_NO_CONSOLE
- 505 ERROR_MOU_EXTENDED_SG
Remarks
MouSetDevStatus is the complement to MouGetDevStatus. However, not all status flags may be set with MouSetDevStatus. Only the flags corresponding to the following functions may be modified:
- Return data in mickeys.
- Normally, mouse data is returned to the application with the absolute display mode coordinates of the pointer image position on the display screen. By setting this status flag, mouse data is returned in relative mickeys, a unit of mouse movement.
- Don't call pointer draw device.
- Normally, the pointer draw device driver is called for all drawing operations. By setting this status flag, the mouse device driver does not call the pointer draw device driver. The application must draw any required pointer image on the screen.
Example Code
C Binding
#define INCL_MOU USHORT rc = MouSetDevStatus(DeviceStatus, DeviceHandle); PUSHORT DeviceStatus; /* Status flags */ HMOU DeviceHandle; /* Mouse device handle */ USHORT rc; /* return code */
MASM Binding
EXTRN MouSetDevStatus:FAR INCL_MOU EQU 1 PUSH@ WORD DeviceStatus ;Status flags PUSH WORD DeviceHandle ;Mouse device handle CALL MouSetDevStatus Returns WORD