Share via

IDirectDrawSurface5::GetSurfaceDesc

  • Article

This 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 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:

DDERR_INVALIDOBJECT
DDERR_INVALIDPARAMS

Requirements

OS Versions: Windows CE 2.12 and later. Version 2.12 requires DXPAK 1.0 or later.
Header: Ddraw.h.
Link Library: Ddraw.lib.

See Also

DDSURFACEDESC | DDSURFACEDESC2

 Last updated on Thursday, April 08, 2004

© 1992-2003 Microsoft Corporation. All rights reserved.