IDirectDrawSurface4::GetSurfaceDesc

The IDirectDrawSurface4::GetSurfaceDesc method retrieves a description of the surface in its current condition.

HRESULT GetSurfaceDesc(
  LPDDSURFACEDESC2 lpDDSurfaceDesc  
);
 

Parameters

lpDDSurfaceDesc

Address of a DDSURFACEDESC2 structure that will be filled with the current description of this surface. You need only initialize this structure's dwSize member to the size, in bytes, of the structure prior to the call; no other preparation is required.

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:

QuickInfo

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Requires Windows 95 or later. Available as a redistributable for Windows 95.
  Header: Declared in ddraw.h.
  Import Library: Use ddraw.lib.

See Also

DDSURFACEDESC, DDSURFACEDESC2