MouGetDevStatus: Difference between revisions
Created page with "==Description== Returns status flags for the installed mouse device driver. ==Syntax== <PRE> #define INCL_MOU #include <os2.h> PULONG DeviceStatus; /* Current status fl..." |
mNo edit summary |
||
| Line 1: | Line 1: | ||
Returns status flags for the installed mouse device driver. | Returns status flags for the installed mouse device driver. | ||
| Line 12: | Line 11: | ||
rc = MouGetDevStatus(DeviceStatus, DeviceHandle); | rc = MouGetDevStatus(DeviceStatus, DeviceHandle); | ||
</PRE> | |||
==Parameters== | ==Parameters== | ||
; DeviceStatus (PULONG) - input : Current status flags. | ;DeviceStatus (PULONG) - input : Current status flags. | ||
Address of the current status-flag settings for the installed mouse device driver. | :Address of the current status-flag settings for the installed mouse device driver. | ||
:The return value is a 4-byte set of bit flags. | |||
The return value is a 4-byte set of bit flags. | Bit Description | ||
31-10 Reserved. Set to 0. | |||
9 If set, mouse data is returned in mickeys, not pels. | |||
31-10 Reserved. Set to | 8 If set, the drawing operations for the pointer draw routine are disabled. | ||
9 If set, mouse data is returned in mickeys, not pels. | 7-4 Reserved. Set to 0. | ||
8 If set, the drawing operations for the pointer draw routine are disabled. | 3 If set, the pointer draw routine is disabled by an unsupported mode. | ||
7-4 Reserved. Set to 0. | 2 If set, a flush is in progress. | ||
3 If set, the pointer draw routine is disabled by an unsupported mode. | 1 If set, a block-read is in progress. | ||
2 If set, a flush is in progress. | 0 If set, the event queue is busy with I/O. | ||
1 If set, a block-read is in progress. | ;DeviceHandle (HMOU) - input : Mouse device handle. | ||
0 If set, the event queue is busy with I/O. | :Reserved. Set to 0. | ||
; DeviceHandle (HMOU) - input : Mouse device handle. | |||
Reserved. Set to 0. | |||
==Return Code== | ==Return Code== | ||
rc (APIRET) - returns | rc (APIRET) - returns | ||
MouDevStatus returns one of the following values: | MouDevStatus returns one of the following values: | ||
* 0 NO_ERROR | |||
* 385 ERROR_MOUSE_NO_DEVICE | |||
* 466 ERROR_MOU_DETACHED | |||
* 501 ERROR_MOUSE_NO_CONSOLE | |||
==Related Functions== | ==Related Functions== | ||
* | * [[MouSetDevStatus]] | ||
[[Category: | [[Category:Mou]] | ||
Revision as of 23:03, 23 December 2016
Returns status flags for the installed mouse device driver.
Syntax
#define INCL_MOU #include <os2.h> PULONG DeviceStatus; /* Current status flags. */ HMOU DeviceHandle; /* Mouse device handle. */ APIRET rc; /* Return code. */ rc = MouGetDevStatus(DeviceStatus, DeviceHandle);
Parameters
- DeviceStatus (PULONG) - input
- Current status flags.
- Address of the current status-flag settings for the installed mouse device driver.
- The return value is a 4-byte set of bit flags.
Bit Description 31-10 Reserved. Set to 0. 9 If set, mouse data is returned in mickeys, not pels. 8 If set, the drawing operations for the pointer draw routine are disabled. 7-4 Reserved. Set to 0. 3 If set, the pointer draw routine is disabled by an unsupported mode. 2 If set, a flush is in progress. 1 If set, a block-read is in progress. 0 If set, the event queue is busy with I/O.
- DeviceHandle (HMOU) - input
- Mouse device handle.
- Reserved. Set to 0.
Return Code
rc (APIRET) - returns
MouDevStatus returns one of the following values:
- 0 NO_ERROR
- 385 ERROR_MOUSE_NO_DEVICE
- 466 ERROR_MOU_DETACHED
- 501 ERROR_MOUSE_NO_CONSOLE