MouDrawPtr: Difference between revisions
No edit summary |
mNo edit summary |
||
| 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== | ||
#define INCL_MOU | #define INCL_MOU | ||
#include <os2.h> | #include <os2.h> | ||
| Line 12: | Line 9: | ||
rc = MouDrawPtr(DeviceHandle); | rc = MouDrawPtr(DeviceHandle); | ||
==Parameters== | ==Parameters== | ||
;DeviceHandle (HMOU) - input :Mouse device handle. | |||
; | :Reserved. Must be 0. | ||
Reserved. Must be 0. | |||
===Return code=== | ===Return code=== | ||
rc (APIRET) - returns | rc (APIRET) - returns | ||
MouDrawPtr returns one of the following values: | MouDrawPtr returns one of the following values: | ||
* 0 NO_ERROR | * 0 NO_ERROR | ||
* 466 ERROR_MOU_DETACHED | * 466 ERROR_MOU_DETACHED | ||
| Line 30: | Line 24: | ||
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]] | ||
Revision as of 22:58, 23 December 2016
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
#define INCL_MOU #include <os2.h> HMOU DeviceHandle; /* Mouse device handle. */ APIRET rc; /* Return code. */ rc = 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.