GreGetDefaultViewingLimits: Difference between revisions

Latest revision as of 08:48, 2 January 2020

GreGetDefaultViewingLimits loads the array indicated by prclViewingLimits with the default boundaries of the viewing window in graphic model space coordinates.

This function is supported by the graphics engine.

Syntax

GreGetDefaultViewingLimits(hdc, prclViewingLimits, pInstance, lFunction)

Parameters

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

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_HDC

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

@@ Line 1: / Line 1: @@
 GreGetDefaultViewingLimits loads the array indicated by prclViewingLimits with the default boundaries of the viewing window in graphic model space coordinates.
 This function is supported by the graphics engine.
 ==Syntax==
-  GreGetDefaultViewingLimits(hdc, prclViewingLimits, pInstance, lFunction);
+ GreGetDefaultViewingLimits(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.
+;pInstance (PVOID) - input:Pointer to instance data.
-;prclViewingLimits (PRECTL) - input
+;lFunction (ULONG) - input:High-order WORD=flags; low-order WORD=NGreGetDefaultViewingLimits.
-: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=NGreGetDefaultViewingLimits.
 ==Return Code==
-;fSuccess (BOOL) - returns
+;fSuccess (BOOL) - returns:Return codes.
-:Return codes.
 :On completion, the handling routine must return BOOLEAN (fSuccess).
+:*TRUE Successful
-:*TRUE Successful
+:*FALSE Error
-:*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
-: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_INV_HDC
+Refer to the "Error Explanations" section of the ''Presentation Manager Programming Reference'' for further explanation.
-:*PMERR_HDC_BUSY
-:*PMERR_INV_HDC
-:Refer to the "Error Explanations" section of the Presentation Manager Programming Reference for further explanation.
-==Sample Code==
-<PRE>
-#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=NGreGetDefaultViewingLimits. */
-BOOL      fSuccess;           /*  Return codes. */
-fSuccess = GreGetDefaultViewingLimits(hdc, prclViewingLimits, pInstance, lFunction);
-</PRE>
 [[Category:Gre]]