GreSetColorCursor

GreSetColorCursor sets the bit maps that define a color cursor or pointer.

Simulation support

This function is mandatory for display drivers. For other drivers, it is simulated by a handling routine in the graphics engine.

Syntax

GreSetColorCursor(hdc, pPointerInfo, pInstance, lFunction);

Parameters

hdc (HDC) - input

The device context handle.

pPointerInfo (PPOINTERINFO) - input

A pointer to a pointer information structure.

pInstance (PVOID) - input

A pointer to instance data.

lFunction (ULONG) - input

High-order WORD=flags; low-order WORD=NGreDeviceSetCursor.

Return Code

fSuccess (BOOL) - returns

Return codes.

On completion, the handling routine must return BOOLEAN (fSuccess).

• TRUE Successful
• FALSE Error

Possible Errors Detected: When an error is detected, the handling routine must call WinSetErrorInfo to post the condition. Error codes for conditions that the handling routine is expected to check include:

• PMERR_DEV_FUNC_NOT_INSTALLED
• PMERR_INV_COORDINATE
• PMERR_INV_CURSOR_BITMAP
• PMERR_INV_HDC

Remarks

The handling routine in the presentation driver updates its copy of the pointer definition to that identified by pPointerInfo.

Declaration

#define INCL_WINPOINTERS
#include <os2.h>

HDC             hdc;           /*  The device context handle. */
PPOINTERINFO    pPointerInfo;  /*  A pointer to a pointer information structure. */
PVOID           pInstance;     /*  A pointer to instance data. */
ULONG           lFunction;     /*  High-order WORD=flags; low-order WORD=NGreDeviceSetCursor. */
BOOL            fSuccess;      /*  Return codes. */

fSuccess = GreSetColorCursor(hdc, pPointerInfo, pInstance, lFunction);