GreGetGraphicsField: Difference between revisions

Revision as of 12:15, 20 January 2020

GreGetGraphicsField loads the buffer indicated by prclGraphicsField with the integer values that identify the boundaries of the graphics field.

This function can be hooked by the presentation driver.

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

Syntax

GreGetGraphicsField(hdc, prclGraphicsField, pInstance, lFunction)

Parameters

hdc (HDC) - input: Device context handle.
prclGraphicsField (PRECTL) - input: Pointer to graphics field.
pInstance (PVOID) - input: Pointer to instance data.
lFunction (ULONG) - input: High-order WORD=flags; low-order WORD=NGreGetGraphicsField.

Returns

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: @@
 GreGetGraphicsField loads the buffer indicated by prclGraphicsField with the integer values that identify the boundaries of the graphics field.
 This function can be hooked by the presentation driver.
 ;Simulation support: This function is simulated by a handling routine in the graphics engine.
 == Syntax ==
-  GreGetGraphicsField(hdc, prclGraphicsField, pInstance, lFunction);
+  GreGetGraphicsField(hdc, prclGraphicsField, pInstance, lFunction)
 == Parameters ==
-;hdc (HDC) - input
+;hdc (HDC) - input:Device context handle.
-:Device context handle.
+;prclGraphicsField ([[PRECTL]]) - input:Pointer to graphics field.
+;pInstance (PVOID) - input:Pointer to instance data.
-;prclGraphicsField (PRECTL) - input
+;lFunction (ULONG) - input:High-order WORD=flags; low-order WORD=NGreGetGraphicsField.
-: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
-;pInstance (PVOID) - input
-:Pointer to instance data.
-;lFunction (ULONG) - input
-:High-order WORD=flags; low-order WORD=NGreGetGraphicsField.
 == Returns ==
-;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.
-== Sample ==
-<pre>
-#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=NGreGetGraphicsField. */
-BOOL      fSuccess;           /*  Return codes. */
-fSuccess = GreGetGraphicsField(hdc, prclGraphicsField,
-             pInstance, lFunction);
-</pre>
 [[Category:Gre]]