Share via


IDirectDraw::GetDisplayMode

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This method retrieves the current display mode.

Syntax

HRESULT GetDisplayMode( 
  LPDDSURFACEDESC lpDDSurfaceDesc
);

Parameters

  • lpDDSurfaceDesc
    Address of a DDSURFACEDESC structure that will be filled with a description of the surface.

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.

Remarks

An application should not save the information returned by this method to restore the display mode on clean-up. The application should use the IDirectDraw::RestoreDisplayMode method to restore the mode on clean-up, thereby avoiding mode-setting conflicts that could arise in a multiprocessor environment.

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

IDirectDraw::SetDisplayMode
IDirectDraw::RestoreDisplayMode
IDirectDraw::EnumDisplayModes