Функция SetConsoleDisplayMode
Важно!
В этом документе описаны функции платформы консоли, которые больше не являются частью стратегии развития экосистемы. Мы не рекомендуем использовать это содержимое в новых продуктах, но мы будем продолжать поддерживать существующие использования для неопределенного будущего. Наше предпочтительное современное решение ориентировано на последовательности виртуальных терминалов для обеспечения максимальной совместимости в кроссплатформенных сценариях. Дополнительные сведения об этом решении по проектированию можно найти в классической консоли и в документе виртуального терминала .
Задает режим отображения указанного буфера экрана консоли.
Синтаксис
BOOL WINAPI SetConsoleDisplayMode(
_In_ HANDLE hConsoleOutput,
_In_ DWORD dwFlags,
_Out_opt_ PCOORD lpNewScreenBufferDimensions
);
Параметры
hConsoleOutput [ввод]
Дескриптор буфера экрана консоли.
dwFlags [in]
Режим отображения консоли. Этот параметр может быть одним или несколькими из следующих значений.
| Значение | Значение |
|---|---|
| CONSOLE_FULLSCREEN_MODE 1 | Текст отображается в полноэкранном режиме. |
| CONSOLE_WINDOWED_MODE 2 | Текст отображается в окне консоли. |
lpNewScreenBufferDimensions [out, необязательный]
Указатель на структуру COORD , которая получает новые измерения буфера экрана в символах.
Возвращаемое значение
Если функция выполняется успешно, возвращается ненулевое значение.
Если функция выполняется неудачно, возвращается нулевое значение. Дополнительные сведения об ошибке можно получить, вызвав GetLastError.
Замечания
Совет
Этот API не рекомендуется и не имеет эквивалента виртуального терминала . Это решение намеренно выравнивает платформу Windows с другими операционными системами, где пользователь получает полный контроль над этим параметром презентации. Удаленное взаимодействие приложений с помощью межплатформенных служебных программ и транспорта, таких как SSH, может не работать должным образом, если используется этот API.
Requirements
| Минимальная версия клиента | Windows XP [только классические приложения] |
| Минимальная версия сервера | Windows Server 2003 [только классические приложения] |
| Верхний колонтитул | ConsoleApi3.h (через WinCon.h, включая Windows.h) |
| Библиотека | Kernel32.lib |
| DLL-библиотеки | Kernel32.dll |