Функция GetLargestConsoleWindowSize

Статья
10/23/2023

Важно!

В этом документе описаны функции платформы консоли, которые больше не являются частью стратегии развития экосистемы. Мы не рекомендуем использовать это содержимое в новых продуктах, но мы будем продолжать поддерживать существующие использования для неопределенного будущего. Наше предпочтительное современное решение ориентировано на последовательности виртуальных терминалов для обеспечения максимальной совместимости в кроссплатформенных сценариях. Дополнительные сведения об этом решении по проектированию можно найти в классической консоли и в документе виртуального терминала .

Извлекает размер максимального возможного окна консоли на основе текущего шрифта и размера дисплея.

Синтаксис

COORD WINAPI GetLargestConsoleWindowSize(
  _In_ HANDLE hConsoleOutput
);

Параметры

hConsoleOutput [ввод]
Дескриптор буфера экрана консоли.

Возвращаемое значение

Если функция выполнена успешно, возвращаемое значение представляет собой структуру COORD, указывающую количество столбцов ячейки символов (член X) и строк (член Y) в максимально возможном окне консоли. В противном случае элементы структуры равны нулю.

Дополнительные сведения об ошибке можно получить, вызвав GetLastError.

Замечания

Функция не учитывает размер буфера экрана консоли, что означает, что возвращаемый размер окна может быть больше размера буфера экрана консоли. Функцию GetConsoleScreenBufferInfo можно использовать для определения максимального размера окна консоли, учитывая текущий размер буфера экрана, текущий шрифт и размер дисплея.

Совет

Этот API не рекомендуется и не имеет эквивалента виртуального терминала . Это решение намеренно выравнивает платформу Windows с другими операционными системами, где пользователь получает полный контроль над этим параметром презентации. Удаленное взаимодействие приложений с помощью межплатформенных служебных программ и транспорта, таких как SSH, может не работать должным образом, если используется этот API.

Requirements


Минимальная версия клиента	Windows 2000 Professional [только классические приложения]
Минимальная версия сервера	Windows 2000 Server [только классические приложения]
Верхний колонтитул	ConsoleApi2.h (через WinCon.h, включая Windows.h)
Библиотека	Kernel32.lib
DLL-библиотеки	Kernel32.dll