MouClose: Difference between revisions

Revision as of 16:25, 2 November 2016

Description

This call closes the mouse device for the current session.

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

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

#define INCL_MOU

USHORT  rc = MouClose(DeviceHandle);

HMOU             DeviceHandle;  /* Mouse device handle */

USHORT           rc;            /* return code */

MASM Binding

EXTRN  MouClose:FAR
INCL_MOU            EQU 1

PUSH   WORD    DeviceHandle  ;Mouse device handle
CALL   MouClose

Returns WORD

@@ Line 3: / Line 3: @@
 ==Syntax==
-<PRE>
+  MouClose (DeviceHandle)
-  MouClose
-    (DeviceHandle)
-</PRE>
 ==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
-* 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===
@@ Line 46: / Line 44: @@
 </PRE>
-==Related Functions==
+[[Category:Mou]]
-*
-[[Category:The OS/2 API Project]]