Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
GetConsoleDisplayMode

GetConsoleDisplayMode function

Retrieves the display mode of the current console.

Syntax


BOOL WINAPI GetConsoleDisplayMode(
  _Out_ LPDWORD lpModeFlags
);

Parameters

lpModeFlags [out]

The display mode of the console. This parameter can be one or more of the following values.

ValueMeaning
CONSOLE_FULLSCREEN
1

Full-screen console. The console is in this mode as soon as the window is maximized. At this point, the transition to full-screen mode can still fail.

CONSOLE_FULLSCREEN_HARDWARE
2

Full-screen console communicating directly with the video hardware. This mode is set after the console is in CONSOLE_FULLSCREEN mode to indicate that the transition to full-screen mode has completed.

 

Return value

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

To compile an application that uses this function, define _WIN32_WINNT as 0x0500 or later. For more information, see Using the Windows Headers.

Requirements

Minimum supported client

Windows XP [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

Wincon.h (include Windows.h)

Library

Kernel32.lib

DLL

Kernel32.dll

See also

Console Functions
Console Modes
SetConsoleDisplayMode

 

 

Community Additions

ADD
Show:
© 2015 Microsoft