GreRestoreXformData

GreRestoreXformData restores a previously saved transform state. The current transform state is overwritten.

This function can be hooked by the presentation driver.

Simulation support

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

Syntax

GreRestoreXformData(hdc, ulSize, pBuffer, pInstance, lFunction)

Parameters

hdc (HDC) - input

Device context handle.

ulSize (ULONG) - input

Size in bytes of pBuffer.

pBuffer (PBYTE) - input

Pointer to stored transform data.

pInstance (PVOID) - input

Pointer to instance data.

lFunction (ULONG) - input

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

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_BASE_ERROR
• PMERR_COORDINATE_OVERFLOW
• PMERR_DEV_FUNC_NOT_INSTALLED
• PMERR_HDC_BUSY
• PMERR_INSUFFICIENT_MEMORY
• PMERR_INV_COORD_SPACE
• PMERR_INV_HDC
• PMERR_INV_IN_AREA
• PMERR_INV_IN_PATH
• PMERR_INV_LENGTH_OR_COUNT
• PMERR_INV_PATTERN_REF_PT_ATTR
• PMERR_INV_PICK_APERTURE_POSN
• PMERR_PATH_LIMIT_EXCEEDED

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

Declaration

#define INCL_GRE_XFORMS
#include <os2.h>

HDC      hdc;        /*  Device context handle. */
ULONG    ulSize;     /*  Size in bytes of pBuffer. */
PBYTE    pBuffer;    /*  Pointer to stored transform data. */
PVOID    pInstance;  /*  Pointer to instance data. */
ULONG    lFunction;  /*  High-order WORD=flags; low-order WORD=NGreRestoreXformData. */
BOOL     fSuccess;   /*  Return codes. */

fSuccess = GreRestoreXformData(hdc, ulSize, pBuffer, pInstance, lFunction);