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.
A version of this page is also available for
4/8/2010

This method retrieves a DDSURFACEDESCstructure describing the current DirectDraw surface.

Syntax 

HRESULT GetSurfaceDesc( 
  DDSURFACEDESC* 
pSurfaceDesc
);

Parameters

pSurfaceDesc

DDSURFACEDESCstructure describing the current DirectDraw surface.

Return Value

Returns an HRESULTvalue.

Remarks

If no surface is allocated, this method returns E_FAIL.

If a DCI primary surface is in use, the DDSURFACEDESCstructure is not filled in and the call returns S_FALSE.

Surfaces are allocated only when the renderer is paused. If the renderer is paused, it cannot release the surfaces when stopped.

Requirements

Windows Embedded CE Windows CE 2.12 and later
Windows Mobile Pocket PC for Windows Mobile Version 5.0 and later, Smartphone for Windows Mobile Version 5.0 and later
Note Microsoft DirectShow applications and DirectShow filters have different include file and Library requirements
For more information, see Setting Up the Build Environment,
Version 2.12 requires DXPAK 1.0 or later