Share via

IDirectDrawSurface5::EnumAttachedSurfaces

  • Article

This method enumerates all the surfaces attached to a given surface.

HRESULT EnumAttachedSurfaces(
  LPVOID lpContext, 
  LPDDENUMSURFACESCALLBACK2 lpEnumSurfacesCallback
);

Parameters

  • lpContext
    Address of the application-defined structure that is passed to the enumeration member every time it is called.
  • lpEnumSurfacesCallback
    Address of the EnumSurfacesCallback2 function that will be called for each surface that is attached to 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
DDERR_SURFACELOST

Remarks

This method enumerates only those surfaces that are directly attached to this surface. For example, in a flipping chain of three or more surfaces, only one surface will be enumerated, because each surface is attached only to the next surface in the flipping chain. In such a configuration, you can call EnumAttachedSurfaces on each successive surface to walk the entire flipping chain.

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

Requirements

OS Versions: Windows CE 2.12 and later. Version 2.12 requires DXPAK 1.0 or later.
Header: Ddraw.h.
Link Library: Ddraw.lib.

 Last updated on Thursday, April 08, 2004

© 1992-2003 Microsoft Corporation. All rights reserved.