GreOffsetRegion

GreOffsetRegion moves the given region by the specified amounts (unless the region is in use as a clipping region when an error is raised).

This function can be hooked by the presentation driver.

Simulation support

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

Syntax

GreOffsetRegion(hdc, hrgn, pdpt, pInstance, lFunction)

Parameters

hdc (HDC) - input

Device context handle.

hrgn (HRGN) - input

Region handle.

pdpt (PPOINTL) - input

Pointer to offset by which region is to be moved, in device coordinates:

• dx X offset
• dy Y offset

pInstance (PVOID) - input

Pointer to instance data.

lFunction (ULONG) - input

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

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_COORDINATE_OVERFLOW
• PMERR_HRGN_BUSY
• PMERR_INV_COORDINATE
• PMERR_INV_HRGN
• PMERR_REGION_IS_CLIP_REGION

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

Sample Code

#define INCL_GRE_REGIONS
#include <os2.h>

HDC        hdc;        /*  Device context handle. */
HRGN       hrgn;       /*  Region handle. */
PPOINTL    pdpt;       /*  Pointer to offset by which region is to be moved, in device coordinates: */
PVOID      pInstance;  /*  Pointer to instance data. */
ULONG      lFunction;  /*  High-order WORD=flags; low-order WORD=NGreOffsetRegion. */
BOOL       fSuccess;   /*  Return codes. */

fSuccess = GreOffsetRegion(hdc, hrgn, pdpt, pInstance, lFunction);