Skip to content

Latest commit

 

History

History
86 lines (64 loc) · 2.98 KB

getconsoledisplaymode.md

File metadata and controls

86 lines (64 loc) · 2.98 KB
Raw
title description author ms.author ms.topic keywords f1_keywords MS-HAID MSHAttr ms.assetid topic_type api_name api_location api_type
GetConsoleDisplayMode function
See reference information about the GetConsoleDisplayMode function, which retrieves the display mode of the current console.
miniksa
miniksa
article
console, character mode applications, command line applications, terminal applications, console api
consoleapi3/GetConsoleDisplayMode
wincon/GetConsoleDisplayMode
GetConsoleDisplayMode
\_win32\_getconsoledisplaymode
base.getconsoledisplaymode
consoles.getconsoledisplaymode
PreferredSiteName:MSDN
PreferredLib:/library/windows/desktop
e19ff900-a671-41d3-a9c8-9e4507c47eff
apiref
GetConsoleDisplayMode
Kernel32.dll
DllExport

GetConsoleDisplayMode function

[!INCLUDE not-recommended-banner]

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.

Value Meaning
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.

Note

The transition to a 100% full screen video hardware mode was removed in Windows Vista with the replatforming of the graphics stack to WDDM. On later versions of Windows, the maximum resulting state is CONSOLE_FULLSCREEN representing a frameless window that appears full screen but isn't in exclusive control of the hardware.

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.

[!INCLUDE no-vt-equiv-user-priv]

Requirements

   
Minimum supported client Windows XP [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Header ConsoleApi3.h (via WinCon.h, include Windows.h)
Library Kernel32.lib
DLL Kernel32.dll

See also

Console Functions

Console Modes

SetConsoleDisplayMode