MouDrawPtr: Difference between revisions
mNo edit summary |
mNo edit summary |
||
| Line 2: | Line 2: | ||
==Syntax== | ==Syntax== | ||
MouDrawPtr(DeviceHandle) | |||
==Parameters== | ==Parameters== | ||
| Line 16: | Line 10: | ||
===Return code=== | ===Return code=== | ||
;rc (APIRET) - returns:MouDrawPtr returns one of the following values: | ;rc (APIRET) - returns:MouDrawPtr returns one of the following values: | ||
* 0 | *0 NO_ERROR | ||
* 466 ERROR_MOU_DETACHED | *466 ERROR_MOU_DETACHED | ||
* 501 ERROR_MOUSE_NO_CONSOLE | *501 ERROR_MOUSE_NO_CONSOLE | ||
==Remarks== | ==Remarks== | ||
Revision as of 23:46, 11 December 2019
Notifies the mouse device driver that an area previously restricted by MouRemovePtr is now available to the mouse device driver when drawing pointer images.
Syntax
MouDrawPtr(DeviceHandle)
Parameters
- DeviceHandle (HMOU) - input
- Mouse device handle.
- Reserved. Must be 0.
Return code
- rc (APIRET) - returns
- MouDrawPtr returns one of the following values:
- 0 NO_ERROR
- 466 ERROR_MOU_DETACHED
- 501 ERROR_MOUSE_NO_CONSOLE
Remarks
MouDrawPtr is required to begin a pointer-image drawing session. At session start, the collision area (the area restricted from pointer-image drawing) is defined as the size of the display.
After a call to MouDrawPtr, MouRemovePtr can be used to define a new collision area. A subsequent call to MouDrawPtr will cancel the collision area.