Platform SDK: DirectX

EnumSurfacesCallback

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

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

Parameters

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

Return Values

The callback function returns DDENUMRET_OK to continue the enumeration.

It returns DDENUMRET_CANCEL to stop the enumeration.

Remarks

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

Requirements

  Windows NT/2000: Requires Windows NT 4.0 SP3 or later.
  Windows 95/98: Requires Windows 95 or later. Available as a redistributable for Windows 95.
  Header: Declared in ddraw.h.
  Import Library: User-defined.