Edit

EngEraseSurface function (winddi.h)

  • Article

The EngEraseSurface function calls GDI to erase the surface; a given rectangle on the surface will be filled with the given color.

Syntax

ENGAPI BOOL EngEraseSurface(
       SURFOBJ *pso,
       RECTL   *prcl,
  [in] ULONG   iColor
);

Parameters

pso

Pointer to the surface to erase.

prcl

Pointer to a RECTL structure that defines which pixels to erase on the surface. This rectangle is exclusive of the bottom and right edges.

[in] iColor

Specifies a color index. This is an index to the value that will be written into each pixel.

Return value

The return value is TRUE if the function is successful. Otherwise, it is FALSE, and an error code is reported.

Requirements

Requirement Value
Minimum supported client Available in Windows 2000 and later versions of the Windows operating systems.
Target Platform Universal
Header winddi.h (include Winddi.h)
Library Win32k.lib
DLL Win32k.sys