GreErasePS

GreErasePS resets the presentation space of the device context to the background color CLR_BACKGROUND. Hardcopy drivers should return TRUE without taking any action.

This function must be supported by the presentation driver. GreErasePS is called from GpiErase, and is used to erase the contents of the presentation space currently associated with the device context. Hardcopy drivers should not take any action except to return TRUE (Successful).

Simulation support

None. This function is mandatory for all drivers.

Syntax

GreErasePS(hdc, pInstance, lFunction)

Parameters

hdc (HDC) - input

Device context handle.

pInstance (PVOID) - input

Pointer to instance data.

lFunction (ULONG) - input

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

Return Code

rc (BOOL) - returns

Return Code.

On completion, the handling routine must return a BOOLEAN value to indicate success or an error.

• 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

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

Remarks

The handling routine does not update GPI_BOUNDS or return correlation data, and it is not affected by the PCTL_DRAW control or COM_DRAW command flag. However, in display drivers, the handling routine should update USER_BOUNDS if the COM_ALT_BOUND command flag is set.

This function is subject to all clipping.