MouSetPtrShape: Difference between revisions
Appearance
Created page with "==Description== Sets the pointer shape and size to be used as the mouse device driver pointer image for all applications in a session. ==Syntax== <PRE> #define INCL_MOU #incl..." |
mNo edit summary |
||
Line 1: | Line 1: | ||
Sets the pointer shape and size to be used as the mouse device driver pointer image for all applications in a session. | Sets the pointer shape and size to be used as the mouse device driver pointer image for all applications in a session. | ||
Line 13: | Line 12: | ||
rc = MouSetPtrShape(PtrBuffer, PtrDefRec, DeviceHandle); | rc = MouSetPtrShape(PtrBuffer, PtrDefRec, DeviceHandle); | ||
</PRE> | |||
==Parameters== | ==Parameters== | ||
; PtrBuffer (PBYTE) - input : Pointer-shape buffer. | ;PtrBuffer (PBYTE) - input : Pointer-shape buffer. | ||
:Address of a buffer containing the bit image used as the pointer shape for the session. The buffer consists of AND and XOR pointer masks. | |||
Address of a buffer containing the bit image used as the pointer shape for the session. The buffer consists of AND and XOR pointer masks | |||
15 Blinking | For CGA-compatible text modes (0, 1, 2, and 3) the following describes the AND and XOR pointer mask bit definitions for each character cell of the masks. Bit values are *colon. | ||
14-12 Background color | 15 Blinking | ||
11 Instensity | 14-12 Background color | ||
10-8 Foreground color | 11 Instensity | ||
7-0 Character | 10-8 Foreground color | ||
7-0 Character | |||
;PtrDefRec (PPTRSHAPE) - input : Pointer definition record. | |||
:Address of the structure where the application stores the necessary data for the pointer draw device driver to build a row-by-column image for each bit plane for the current display mode. | |||
; DeviceHandle (HMOU) - input : Reserved. Must be 0. | |||
==Return Code== | ==Return Code== | ||
rc (APIRET) - returns | rc (APIRET) - returns | ||
MouSetPtrShape returns one of the following values: | MouSetPtrShape returns one of the following values: | ||
* 0 NO_ERROR | |||
* 387 ERROR_MOUSE_INV_PARMS | |||
* 466 ERROR_MOU_DETACHED | |||
* 501 ERROR_MOUSE_NO_CONSOLE | |||
==Related Functions== | ==Related Functions== | ||
*[[MouGetPtrShape]] | |||
[[Category:Mou]] | |||
[[Category: |
Revision as of 22:39, 23 December 2016
Sets the pointer shape and size to be used as the mouse device driver pointer image for all applications in a session.
Syntax
#define INCL_MOU #include <os2.h> PBYTE PtrBuffer; /* Pointer-shape buffer. */ PPTRSHAPE PtrDefRec; /* Pointer definition record. */ HMOU DeviceHandle; /* Reserved. Must be 0. */ APIRET rc; /* Return code. */ rc = MouSetPtrShape(PtrBuffer, PtrDefRec, DeviceHandle);
Parameters
- PtrBuffer (PBYTE) - input
- Pointer-shape buffer.
- Address of a buffer containing the bit image used as the pointer shape for the session. The buffer consists of AND and XOR pointer masks.
For CGA-compatible text modes (0, 1, 2, and 3) the following describes the AND and XOR pointer mask bit definitions for each character cell of the masks. Bit values are *colon.
15 Blinking 14-12 Background color 11 Instensity 10-8 Foreground color 7-0 Character
- PtrDefRec (PPTRSHAPE) - input
- Pointer definition record.
- Address of the structure where the application stores the necessary data for the pointer draw device driver to build a row-by-column image for each bit plane for the current display mode.
- DeviceHandle (HMOU) - input
- Reserved. Must be 0.
Return Code
rc (APIRET) - returns
MouSetPtrShape returns one of the following values:
- 0 NO_ERROR
- 387 ERROR_MOUSE_INV_PARMS
- 466 ERROR_MOU_DETACHED
- 501 ERROR_MOUSE_NO_CONSOLE