IDirectDrawSurface5::EnumOverlayZOrders

Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.

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

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

Parameters

dwFlags

One of the following flags:

DDENUMOVERLAYZ_BACKTOFRONT	Enumerates overlays back to front.
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 EnumSurfacesCallback2callback function that will be called for each surface being overlaid on this surface.

Return Values

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:

DDERR_INVALIDOBJECT

DDERR_INVALIDPARAMS

Remarks

This method differs from its counterparts in previous interface versions in that it accepts a pointer to an EnumSurfacesCallback2function, rather than an EnumSurfacesCallbackfunction.

Requirements

Runs on	Versions	Declared in	Link to
Windows CE OS	2.12 or later. Version 2.12 requires DXPAK 1.0 or later.	ddraw.h	ddraw.lib