DirectX SDK

IDirectDrawSurface7::GetSurfaceDesc

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

HRESULT GetSurfaceDesc(
  LPDDSURFACEDESC2 lpDDSurfaceDesc  
);

Parameters

lpDDSurfaceDesc
Address of a DDSURFACEDESC2 structure to 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 it fails, the method can return one of the following error values:

DDERR_INVALIDOBJECT
DDERR_INVALIDPARAMS

Requirements

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Requires Windows 98.
  Header: Declared in ddraw.h.

See Also

DDSURFACEDESC, DDSURFACEDESC2