EnumSurfacesCallback

  • Article

This function is an application-defined callback function for the IDirectDraw2::EnumSurfaces, IDirectDrawSurface3::EnumAttachedSurfaces, and IDirectDrawSurface3::EnumOverlayZOrders methods (and the versions from earlier interfaces).

This callback function is only used with older DirectDraw interfaces. It is superseded by the EnumSurfacesCallback2 function for the IDirectDraw4::EnumSurfaces, IDirectDrawSurface5::EnumAttachedSurfaces, and IDirectDrawSurface5::EnumOverlayZOrders methods.

HRESULT WINAPI EnumSurfacesCallback( 
  LPDIRECTDRAWSURFACE lpDDSurface, 
  LPDDSURFACEDESC lpDDSurfaceDesc, 
  LPVOID lpContext
);

Parameters

  • lpDDSurface
    [in] Address of the IDirectDrawSurface interface for the attached surface.
  • lpDDSurfaceDesc
    [in] Address of a DDSURFACEDESC structure that describes the attached surface.
  • lpContext
    [in] Address of an application-defined structure that will be passed to the callback function each time the function is called.

Return Values

The callback function returns DDENUMRET_OK to continue the enumeration.

The callback function returns DDENUMRET_CANCEL to stop it.

Remarks

You can use the LPDDENUMSURFACESCALLBACK data type to declare a variable that can contain a pointer to this callback function.

Requirements

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

 Last updated on Thursday, April 08, 2004

© 1992-2003 Microsoft Corporation. All rights reserved.