GreGetViewingLimits: Difference between revisions

Latest revision as of 05:32, 28 December 2019

GreGetViewingLimits loads the array indicated by prclViewingLimits with the boundaries of the viewing window in graphic model-space coordinates. All boundaries are inclusive.

This function can be hooked by the presentation driver.

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

Syntax

fSuccess = GreGetViewingLimits(hdc, prclViewingLimits, pInstance, lFunction)

Parameters

hdc (HDC) - input: Device context handle.
prclViewingLimits (PRECTL) - input: Pointer to limits of viewing area (RECTL structure)
pInstance (PVOID) - input: Pointer to instance data.
lFunction (ULONG) - input: High-order WORD=flags; low-order WORD=NGreGetViewingLimits.

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_HDC

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

@@ Line 1: / Line 1: @@
 GreGetViewingLimits loads the array indicated by prclViewingLimits with the boundaries of the viewing window in graphic model-space coordinates. All boundaries are inclusive.
 This function can be hooked by the presentation driver.
 ;Simulation support: This function is simulated by a handling routine in the graphics engine.
 ==Syntax==
-  fSuccess = GreGetViewingLimits(hdc, prclViewingLimits, pInstance, lFunction);
+  fSuccess = GreGetViewingLimits(hdc, prclViewingLimits, pInstance, lFunction)
 ==Parameters==
-;hdc (HDC) - input
+;hdc (HDC) - input:Device context handle.
-:Device context handle.
+;prclViewingLimits ([[PRECTL]]) - input:Pointer to limits of viewing area (RECTL structure)
+;pInstance (PVOID) - input:Pointer to instance data.
-;prclViewingLimits (PRECTL) - input
+;lFunction (ULONG) - input:High-order WORD=flags; low-order WORD=NGreGetViewingLimits.
-: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=NGreGetViewingLimits.
 ==Return Code==
-;fSuccess (BOOL) - returns
+;fSuccess (BOOL) - returns:Return codes.
-:Return codes.
+This function returns BOOLEAN (fSuccess).
+*TRUE Successful
-This function returns BOOLEAN (fSuccess).
+*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:
-*TRUE Successful
+*PMERR_HDC_BUSY
-*FALSE Error
+*PMERR_INV_HDC
+Refer to the "Error Explanations" section in the Presentation Manager Programming Reference for further explanation.
-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_HDC
-Refer to the "Error Explanations" section in the Presentation Manager Programming Reference for further explanation.
-==Example Code==
-<PRE>
-#define INCL_GRE_XFORMS
-#include <os2.h>
-HDC       hdc;                /*  Device context handle. */
-PRECTL    prclViewingLimits;  /*  Pointer to limits of viewing area (RECTL structure): */
-PVOID     pInstance;          /*  Pointer to instance data. */
-ULONG     lFunction;          /*  High-order WORD=flags; low-order WORD=NGreGetViewingLimits. */
-BOOL      fSuccess;           /*  Return codes. */
-fSuccess = GreGetViewingLimits(hdc, prclViewingLimits,
-             pInstance, lFunction);
-</PRE>
 [[Category:Gre]]