GreSetDefaultViewingLimits

GreSetDefaultViewingLimits sets the boundaries of the default viewing (clip) limits to the values specified by prclViewingLimits.

This function is supported by the graphics engine.

Syntax

GreSetDefaultViewingLimits(hdc, prclViewingLimits, pInstance, lFunction);

Parameters

hdc (HDC) - input

Device context handle.

prclViewingLimits (PRECTL) - input

Pointer to limits of viewing area.

RECTL structure:

xLeft

Minimum x-coordinate of viewing limits

yBottom

Minimum y-coordinate

xRight

Maximum x-coordinate of viewing limits

yTop

Maximum y-coordinate

pInstance (PVOID) - input

Pointer to instance data.

lFunction (ULONG) - input

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

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 graphics engine calls WinSetErrorInfo to post the condition. Reasons for failure of this function 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 of the Presentation Manager Programming Reference for further explanation.

Remarks

The current viewing limits are unaffected by a call to this function (see GreGetViewingLimits).

Example Code

#define INCL_GRE_DEVSUPPORT
#include <os2.h>

HDC       hdc;                /*  Device context handle. */
PRECTL    prclViewingLimits;  /*  Pointer to limits of viewing area. */
PVOID     pInstance;          /*  Pointer to instance data. */
ULONG     lFunction;          /*  High-order WORD=flags; low-order WORD=NGreSetDefaultViewingLimits. */
BOOL      fSuccess;           /*  Return codes. */

fSuccess = GreSetDefaultViewingLimits(hdc,
             prclViewingLimits, pInstance,
             lFunction);