SetConsoleDisplayMode function

Article
02/12/2021

Important

This document describes console platform functionality that is no longer a part of our ecosystem roadmap. We do not recommend using this content in new products, but we will continue to support existing usages for the indefinite future. Our preferred modern solution focuses on virtual terminal sequences for maximum compatibility in cross-platform scenarios. You can find more information about this design decision in our classic console vs. virtual terminal document.

Sets the display mode of the specified console screen buffer.

Syntax

BOOL WINAPI SetConsoleDisplayMode(
  _In_      HANDLE hConsoleOutput,
  _In_      DWORD  dwFlags,
  _Out_opt_ PCOORD lpNewScreenBufferDimensions
);

Parameters

hConsoleOutput [in]
A handle to the console screen buffer.

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

Value	Meaning
CONSOLE_FULLSCREEN_MODE 1	Text is displayed in full-screen mode.
CONSOLE_WINDOWED_MODE 2	Text is displayed in a console window.

lpNewScreenBufferDimensions [out, optional]
A pointer to a COORD structure that receives the new dimensions of the screen buffer, in characters.

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

Tip

This API is not recommended and does not have a virtual terminal equivalent. This decision intentionally aligns the Windows platform with other operating systems where the user is granted full control over this presentation option. Applications remoting via cross-platform utilities and transports like SSH may not work as expected if using this API.

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