MouDrawPtr: Difference between revisions

Revision as of 18:34, 9 June 2016

Description

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.

Example Code

Related Functions

[[OS2 API:CPI:

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