SetConsoleDisplayMode Function

Sets the display mode of the specified console screen buffer.

Syntax

C++
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 clientWindows XP
Minimum supported serverWindows Server 2003
HeaderWincon.h (include Windows.h)
LibraryKernel32.lib
DLLKernel32.dll

See Also

Console Functions
Console Modes
GetConsoleDisplayMode

Send comments about this topic to Microsoft

Build date: 10/8/2009

Tags :


Community Content

MartinNvP
This function not defined in wincon.h , with MSVC 2005
I can clearly see the GetConsoleDisplayMode() function in wincon.h
But the corresponding SetConsoleDisplayMode() function is not present.

You may need to use:

int NT_SetConsoleDisplayMode(HANDLE hOutputHandle, DWORD dwNewMode)
{
typedef BOOL (WINAPI *SCDMProc_t) (HANDLE, DWORD, LPDWORD);

SCDMProc_t SetConsoleDisplayMode;
HMODULE hKernel32;
BOOL bFreeLib = FALSE, ret;
const char KERNEL32_NAME[] = "kernel32.dll";

hKernel32 = GetModuleHandleA(KERNEL32_NAME);
if (hKernel32 == NULL)
{
hKernel32 = LoadLibraryA(KERNEL32_NAME);
if (hKernel32 == NULL)
return FALSE;
bFreeLib = true;
}//if
SetConsoleDisplayMode =
(SCDMProc_t)GetProcAddress(hKernel32, "SetConsoleDisplayMode");
if (SetConsoleDisplayMode == NULL)
{
SetLastError(ERROR_CALL_NOT_IMPLEMENTED);
ret = FALSE;
}//if
else
{
DWORD dummy;
ret = SetConsoleDisplayMode(hOutputHandle, dwNewMode, &dummy);
}//else
if (bFreeLib)
FreeLibrary(hKernel32);
return ret;
}
Tags :

Page view tracker