GreRegionSelectBitmap

GreRegionSelectBitmap is called when a new bit-map handle is selected into a memory DC. It removes the old visible region and informs the presentation driver that the DC region must be recalculated.

Note: In a nondisplay DC, the visible region represents the device boundary.

This function can be hooked by the presentation driver.

Simulation support: This function is simulated by a handling routine in the graphics engine.

Syntax

GreRegionSelectBitmap(hdc, hbm, pInstance, lFunction)

Parameters

hdc (HDC) - input: Device context handle.
hbm (HBITMAP) - input: Handle of bit map to be selected.
pInstance (PVOID) - input: Pointer to instance data.
lFunction (ULONG) - input: High-order WORD=flags; low-order WORD=NGreRegionSelectBitmap.

Return Code

fSuccess (BOOL) - returns

Return codes.

This function returns 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_HDC_BUSY
PMERR_INSUFFICIENT_MEMORY
PMERR_INV_COORDINATE
PMERR_INV_HDC
PMERR_INV_HRGN
PMERR_INV_RECT
PMERR_INV_REGION_CONTROL

Refer to the "Error Explanations" section in the Presentation Manager Programming Reference for further explanation.

Declaration

#define INCL_GRE_CLIP
#include <os2.h>

HDC        hdc;        /*  Device context handle. */
HBITMAP    hbm;        /*  Handle of bit map to be selected. */
PVOID      pInstance;  /*  Pointer to instance data. */
ULONG      lFunction;  /*  High-order WORD=flags; low-order WORD=NGreRegionSelectBitmap. */
BOOL       fSuccess;   /*  Return codes. */

fSuccess = GreRegionSelectBitmap(hdc, hbm, pInstance, lFunction);