MouGetDevStatus: Difference between revisions

Revision as of 19:07, 11 March 2018

Returns status flags for the installed mouse device driver.

Syntax

MouGetDevStatus(DeviceStatus, DeviceHandle)

Parameters

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.

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.
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

Related Functions

MouSetDevStatus

@@ Line 2: / Line 2: @@
 ==Syntax==
-<PRE>
+  MouGetDevStatus(DeviceStatus, DeviceHandle)
-#define INCL_MOU
-#include <os2.h>
-PULONG    DeviceStatus;  /*  Current status flags. */
-HMOU      DeviceHandle;  /*  Mouse device handle. */
-APIRET    rc;            /*  Return code. */
-rc = MouGetDevStatus(DeviceStatus, DeviceHandle);
-</PRE>
 ==Parameters==
-;DeviceStatus (PULONG) - input : Current status flags.
+{|class="wikitable" align=right
+!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.
+|}
+;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
--10        Reserved. Set to 0.
-            If set, mouse data is returned in mickeys, not pels.
-            If set, the drawing operations for the pointer draw routine are disabled.
--4          Reserved. Set to 0.
-            If set, the pointer draw routine is disabled by an unsupported mode.
-            If set, a flush is in progress.
-            If set, a block-read is in progress.
-            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
+;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