subcalls.hlp (Topic list)
Important Notice
The pages on this site contain documentation for very old MS-DOS software, purely for historical purposes. If you're looking for up-to-date documentation, particularly for programming, you should not rely on the information found here, as it will be woefully out of date.
MouGetDevStatus (1.2)
Overview                                            Up Next Previous
────────────────────────────────────────────────────────────────────────────
 
#define INCL_MOU
 
USHORT MouGetDevStatus(pfsDevStatus, hmou)
PUSHORT pfsDevStatus;    /* address of buffer for status */
HMOU hmou;               /* mouse handle                 */
 
The MouGetDevStatus function retrieves the device status for the specified
mouse.
 
Parameter     Description
────────────────────────────────────────────────────────────────────────────
 
pfsDevStatus  Points to the variable that receives the device status. It can
              be any combination of the following values:
 
              Value                   Meaning
              ──────────────────────────────────────────────────────────────
              MOUSE_QUEUEBUSY         Event queue is busy with input/output
                                      (I/O).
 
              MOUSE_BLOCKREAD         Block read is in progress.
 
              MOUSE_FLUSH             Flush buffer is in progress.
 
              MOUSE_UNSUPPORTED_MODE  Mouse device driver is disabled
                                      because of unsupported mode.
 
              MOUSE_DISABLED          Mouse device driver is disabled.
 
              MOUSE_MICKEYS           Mouse motion is given in mickeys, not
                                      in pels.
 
hmou          Identifies the mouse. The handle must have been created
              previously by using the MouOpen function.
 
Return Value
 
The return value is zero if the function is successful. Otherwise, it is an
error value, which may be the following:
 
     ERROR_MOUSE_NO_DEVICE
 
Example
 
This example creates a mouse handle then calls the MouGetDevStatus function
to retrieve the status for the mouse identified by the handle:
 
USHORT fsDevStatus;
HMOU hmou;
MouOpen(0L, &hmou);
MouGetDevStatus(&fsDevStatus, hmou);
if (fsDevStatus & MOUSE_DISABLED ||
        fsDevStatus & MOUSE_UNSUPPORTED_MODE)
    VioWrtTTY("mouse is disabled\r\n", 19, 0);
 
See Also
 
MouOpen, MouSetDevStatus
 
                                      ♦