GreGetPageUnits

GreGetPageUnits returns the page units for the specified display context. On completion, the structure addressed by pExtent contains the dimensions of the page expressed in the units indicated by the return value of this function.

This function can be hooked by the presentation driver.

Simulation support

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

Syntax

GreGetPageUnits(hdc, pExtent, pInstance, lFunction)

Parameters

hdc (HDC) - input

Device context handle.

pExtent (PSIZEL) - input

Pointer to a SIZEL structure where the page dimensions are returned.

pInstance (PVOID) - input

Pointer to instance data.

lFunction (ULONG) - input

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

Returns

rc (ULONG) - returns

Return codes.

This function returns the page units, or GPI_ERROR if an error occurred. The defined page units are described under GreSetPageUnits.

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

#define INCL_GRE_XFORMS
#include <os2.h>

HDC       hdc;       /* Device context handle. */
PSIZEL    pExtent;   /* Pointer to a SIZEL structure where the page dimensions are returned. */
PVOID     pInstance; /* Pointer to instance data. */
ULONG     lFunction; /* High-order WORD=flags; low-order WORD=NGreGetPageUnits. */
ULONG     rc;        /* Return codes. */

rc = GreGetPageUnits(hdc, pExtent, pInstance, lFunction);