Export (0) Print
Expand All

SetConsoleDisplayMode function

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.

ValueMeaning
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.

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
GetConsoleDisplayMode

 

 

Community Additions

ADD
Show:
© 2014 Microsoft