GreSetGraphicsField

GreSetGraphicsField sets the boundaries of the graphics field (clip) limits in page-coordinate space. The boundaries are inclusive so that points on them are not clipped. By default, no clipping is performed.

This function can be hooked by the presentation driver.

Simulation support

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

Syntax

GreSetGraphicsField(hdc, prclGraphicsField, pInstance, lFunction);

Parameters

hdc (HDC) - input

Device context handle.

prclGraphicsField (PRECTL) - input

Pointer to graphics field.

RECTL structure:

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

An error is raised when xLeft is greater than xRight, or yBottom is greater than yTop.

pInstance (PVOID) - input

Pointer to instance data.

lFunction (ULONG) - input

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

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_HDC_BUSY
• PMERR_INV_COORDINATE
• PMERR_INV_GRAPHICS_FIELD
• PMERR_INV_HDC
• PMERR_INV_IN_AREA
• PMERR_INV_IN_PATH

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

Declaration

#define INCL_GRE_XFORMS
#include <os2.h>

HDC       hdc;                /*  Device context handle. */
PRECTL    prclGraphicsField;  /*  Pointer to graphics field. */
PVOID     pInstance;          /*  Pointer to instance data. */
ULONG     lFunction;          /*  High-order WORD=flags; low-order WORD=NGreSetGraphicsField. */
BOOL      fSuccess;           /*  Return codes. */

fSuccess = GreSetGraphicsField(hdc, prclGraphicsField, pInstance, lFunction);