IDirectDrawSurface5::GetSurfaceDesc

Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.

The IDirectDrawSurface5::GetSurfaceDescmethod retrieves a description of the surface in its current condition.

HRESULT GetSurfaceDesc(
LPDDSURFACEDESC2
lpDDSurfaceDesc
);

Parameters

lpDDSurfaceDesc

Address of a DDSURFACEDESC2structure that will be filled with the current description of this surface. You only initialize this structure's dwSizemember 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:

DDERR_INVALIDOBJECT

DDERR_INVALIDPARAMS

Requirements

Runs on	Versions	Declared in	Link to
Windows CE OS	2.12 or later. Version 2.12 requires DXPAK 1.0 or later.	ddraw.h	ddraw.lib

See Also

DDSURFACEDESC, DDSURFACEDESC2