IDirectDraw4::GetDisplayMode

  • Article

The IDirectDraw4::GetDisplayMode method retrieves the current display mode.

HRESULT GetDisplayMode( 
LPDDSURFACEDESC2 lpDDSurfaceDesc2);

Parameters

  • lpDDSurfaceDesc2
    Address of a DDSURFACEDESC2 structure that will be filled with a description of the surface.

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
DDERR_UNSUPPORTEDMODE

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 IDirectDraw4::RestoreDisplayMode method to restore the mode on clean-up, thereby avoiding mode-setting conflicts that could arise in a multiprocessor environment.

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

IDirectDraw4::SetDisplayMode, IDirectDraw4::RestoreDisplayMode, IDirectDraw4::EnumDisplayModes

 Last updated on Tuesday, July 13, 2004

© 1992-2000 Microsoft Corporation. All rights reserved.