MouDrawPtr: Difference between revisions
No edit summary |
|||
| (4 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
Notifies the mouse device driver that an area previously restricted by [[MouRemovePtr]] is now available to the mouse device driver when drawing pointer images. | |||
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== | ==Syntax== | ||
MouDrawPtr(DeviceHandle) | |||
==Parameters== | ==Parameters== | ||
;DeviceHandle (HMOU) - input :Mouse device handle. | |||
:Reserved. Must be 0. | |||
; | ;rc (APIRET) - returns:Return code: | ||
::0 NO_ERROR | |||
::466 ERROR_MOU_DETACHED | |||
::501 ERROR_MOUSE_NO_CONSOLE | |||
==Remarks== | ==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. | 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. | 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. | ||
==Related Functions== | ==Related Functions== | ||
* [[ | * [[MouRemovePtr]] | ||
[[Category: | [[Category:Mou]] | ||
Latest revision as of 23:47, 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.
- rc (APIRET) - returns
- Return code:
- 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.