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.
Requirements
| Minimum supported client | Windows XP |
| Minimum supported server | Windows Server 2003 |
| Header | Wincon.h (include Windows.h) |
| Library | Kernel32.lib |
| DLL | Kernel32.dll |
See Also
- Console Functions
- Console Modes
- GetConsoleDisplayMode
Send comments about this topic to Microsoft
Build date: 10/8/2009