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.
A version of this page is also available for
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 EnumSurfacesCallbackcallback 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:

DDERR_INVALIDOBJECT

DDERR_INVALIDPARAMS

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

Remarks

Requirements

Header ddraw.h
Library ddraw.lib
Windows Embedded CE Windows Embedded CE 6.0 and later
Windows Mobile Pocket PC for Windows Mobile Version 5.0 and later, Smartphone for Windows Mobile Version 5.0 and later