MouClose: Difference between revisions
m Ak120 moved page OS2 API:CPI:LEGACY:MouClose to MouClose |
mNo edit summary |
||
| Line 1: | Line 1: | ||
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== | ==Syntax== | ||
| Line 6: | Line 5: | ||
==Parameters== | ==Parameters== | ||
; DeviceHandle (HMOU) - input : Mouse device handle from a previous MouOpen. | ;DeviceHandle (HMOU) - input : Mouse device handle from a previous MouOpen. | ||
==Return Code== | ==Return Code== | ||
rc (USHORT) - return | rc (USHORT) - return | ||
Return code descriptions are: | Return code descriptions are: | ||
* 0 - NO_ERROR | * 0 - NO_ERROR | ||
| Line 17: | Line 15: | ||
* 501 - ERROR_MOUSE_NO_CONSOLE | * 501 - ERROR_MOUSE_NO_CONSOLE | ||
* 505 - ERROR_MOU_EXTENDED_SG | * 505 - ERROR_MOU_EXTENDED_SG | ||
==Example Code== | ==Example Code== | ||
| Line 29: | Line 24: | ||
HMOU DeviceHandle; /* Mouse device handle */ | HMOU DeviceHandle; /* Mouse device handle */ | ||
USHORT rc; /* return code */ | USHORT rc; /* return code */ | ||
</PRE> | </PRE> | ||
Revision as of 22:50, 23 December 2016
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
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