MouClose: Difference between revisions

Latest revision as of 22:36, 7 December 2022

MouClose closes the mouse device for the current session and removes the mouse device driver handle from the list of valid open mouse device handles.

Syntax

MouClose (DeviceHandle)

Parameters

DeviceHandle (HMOU) - input: Mouse device handle from a previous MouOpen.

Return Code

rc (USHORT) - return: Return code descriptions are:

0 - NO_ERROR
385 - ERROR_MOUSE_NO_DEVICE
466 - ERROR_MOU_DETACHED
501 - ERROR_MOUSE_NO_CONSOLE
505 - ERROR_MOU_EXTENDED_SG

Bindings

C

#define INCL_MOU

USHORT  rc = MouClose(DeviceHandle);

HMOU    DeviceHandle;  /* Mouse device handle */
USHORT  rc;            /* return code */

MASM

EXTRN  MouClose:FAR
INCL_MOU    EQU 1

PUSH   WORD    DeviceHandle  ;Mouse device handle
CALL   MouClose

Returns WORD

@@ Line 1: / Line 1: @@
-==Description==
+MouClose closes the mouse device for the current session and removes the mouse device driver handle from the list of valid open mouse device handles.
-This call closes the mouse device for the current session.
 ==Syntax==
-<PRE>
+  MouClose (DeviceHandle)
-  MouClose
-    (DeviceHandle)
+==Parameters==
-</PRE>
+;DeviceHandle (HMOU) - input : Mouse device handle from a previous [[MouOpen]].
-==Parameters==
-; DeviceHandle (HMOU) - input : Mouse device handle from a previous MouOpen.
 ==Return Code==
- rc (USHORT) - return
+;rc (USHORT) - return:Return code descriptions are:
+* 0 - NO_ERROR
+* 385 - ERROR_MOUSE_NO_DEVICE
+* 466 - ERROR_MOU_DETACHED
+* 501 - ERROR_MOUSE_NO_CONSOLE
+* 505 - ERROR_MOU_EXTENDED_SG
-Return code descriptions are:
+==Bindings==
+=== C ===
-* 0    NO_ERROR
-* 385        ERROR_MOUSE_NO_DEVICE
-* 466        ERROR_MOU_DETACHED
-* 501        ERROR_MOUSE_NO_CONSOLE
-* 505        ERROR_MOU_EXTENDED_SG
-==Remarks==
-MouClose closes the mouse device for the current session and removes the mouse device driver handle from the list of valid open mouse device handles.
-==Example Code==
-=== C Binding===
 <PRE>
 #define INCL_MOU
@@ Line 30: / Line 22: @@
 USHORT  rc = MouClose(DeviceHandle);
-HMOU             DeviceHandle;  /* Mouse device handle */
+HMOU    DeviceHandle;  /* Mouse device handle */
+USHORT  rc;            /* return code */
-USHORT           rc;            /* return code */
 </PRE>
-===MASM Binding===
+===MASM===
 <PRE>
 EXTRN  MouClose:FAR
-INCL_MOU            EQU 1
+INCL_MOU    EQU 1
 PUSH   WORD    DeviceHandle  ;Mouse device handle
@@ Line 46: / Line 37: @@
 </PRE>
-==Related Functions==
+[[Category:Mou]]
-*
-[[Category:The OS/2 API Project]]