Share via


IDirectDrawSurface::GetSurfaceDesc

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This method retrieves a description of the surface in its current condition.

Syntax

HRESULT GetSurfaceDesc(
  LPDDSURFACEDESC lpDDSurfaceDesc
); 

Parameters

  • lpDDSurfaceDesc
    Address of a DDSURFACEDESC 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 Value

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

For more information on these error codes see DirectDraw Return Values.

Requirements

Header ddraw.h
Library ddraw.lib
Windows Embedded CE Windows Embedded CE 6.0 and later
Windows Mobile Pocket PC for Windows Mobile Version 5.0 and later, Smartphone for Windows Mobile Version 5.0 and later

See Also

Reference

DDSURFACEDESC