GreSetXformRect

GreSetXformRect intersects a rectangle in device coordinates with the DC region. The rectangle is inclusive at the bottom and left boundaries, exclusive at the top and right boundaries.

This function can be hooked by the presentation driver.

Simulation support

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

Syntax

GreSetXformRect(hdc, prclRect, pInstance, lFunction);

Parameters

hdc (HDC) - input

Device context handle.

prclRect (PRECTL) - input

Pointer to a rectangle in device coordinates.

RECTL structure:

• xLeft Minimum x-coordinate of rectangle
• yBottom Minimum y-coordinate
• xRight Maximum x-coordinate of rectangle
• yTop Maximum y-coordinate

pInstance (PVOID) - input

Pointer to instance data.

lFunction (ULONG) - input

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

Return Code

rc (LONG) - returns

Return codes.

This function returns an integer (lComplexity) indicating the complexity of the DC region:

• RGN_ERROR Error
• RGN_NULL Null region
• RGN_RECT Rectangular region
• RGN_COMPLEX Complex region (more than 1 rectangle)

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. */
PRECTL    prclRect;   /*  Pointer to a rectangle in device coordinates. */
PVOID     pInstance;  /*  Pointer to instance data. */
ULONG     lFunction;  /*  High-order WORD=flags; low-order WORD=NGreSetXformRect. */
LONG      rc;         /*  Return codes. */

rc = GreSetXformRect(hdc, prclRect, pInstance, lFunction);