IDirectDrawSurface3::GetSurfaceDesc

The IDirectDrawSurface3::GetSurfaceDesc method retrieves a DDSURFACEDESC structure that describes the surface in its current condition.

HRESULT GetSurfaceDesc(
  LPDDSURFACEDESC lpDDSurfaceDesc  
);
 

Parameters

lpDDSurfaceDesc
Address of a DDSURFACEDESC structure that will be filled with the current description of 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

QuickInfo

  Windows NT: Use version 5.0 or later.
  Windows: Use Windows 95 or later. Available as a redistributable for Windows 95.
  Windows CE: Unsupported.
  Header: Declared in ddraw.h.
  Import Library: Use ddraw.lib.

See Also

DDSURFACEDESC