MouDrawPtr: Difference between revisions

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.

Related Functions

MouRemovePtr

@@ Line 1: / Line 1: @@
-==Remarks==
+Notifies the mouse device driver that an area previously restricted by [[MouRemovePtr]] is now available to the mouse device driver when drawing pointer images.
-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.
 ==Syntax==
-Notifies the mouse device driver that an area previously restricted by MouRemovePtr is now available to the mouse device driver when drawing pointer images.
+  MouDrawPtr(DeviceHandle)
-  #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.
-'''DeviceHandle''' (HMOU) - input
+;rc (APIRET) - returns:Return code:
+::0 NO_ERROR
+::466 ERROR_MOU_DETACHED
+::501 ERROR_MOUSE_NO_CONSOLE
-    Mouse device handle.
+==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.
-    Reserved. Must be 0.
-==Returns==
-rc (APIRET) - returns
-===Return code===
-MouDrawPtr returns one of the following values:
+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.
-    NO_ERROR 466
+==Related Functions==
-    ERROR_MOU_DETACHED 501
+* [[MouRemovePtr]]
-    ERROR_MOUSE_NO_CONSOLE
-[[Category:The OS/2 API Project]]
+[[Category:Mou]]