IDirectDrawSurface::EnumOverlayZOrders

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This method enumerates the overlay surfaces on the specified destination. The overlays can be enumerated in front-to-back or back-to-front order.

Syntax

HRESULT EnumOverlayZOrders(
  DWORD dwFlags, 
  LPVOID lpContext, 
  LPDDENUMSURFACESCALLBACK lpfnCallback
); 

Parameters

• dwFlags
  The following table shows the possible flags.

  Flag	Description
  DDENUMOVERLAYZ_FRONTTOBACK	Enumerates overlays front to back.

• lpContext
  Address of the user-defined context that will be passed to the callback function for each overlay surface.

• lpfnCallback
  Address of the EnumSurfacesCallback callback function that will be called for each surface being overlaid on this surface.

Return Value

If the method succeeds, the return value is DD_OK.

If the method fails, the return value may be one of the following error values:

For more information on these error codes see DirectDraw Return Values.

Remarks

Requirements