Функция GetConsoleScreenBufferInfo

Статья
12/13/2023

Извлекает сведения о указанном буфере экрана консоли.

Синтаксис

BOOL WINAPI GetConsoleScreenBufferInfo(
  _In_  HANDLE                      hConsoleOutput,
  _Out_ PCONSOLE_SCREEN_BUFFER_INFO lpConsoleScreenBufferInfo
);

Параметры

hConsoleOutput [ввод]
Дескриптор буфера экрана консоли. Этот дескриптор должен иметь право доступа GENERIC_READ. Дополнительные сведения см. в статье Безопасность и права доступа для буфера консоли.

lpConsoleScreenBufferInfo [out]
Указатель на структуру CONSOLE_SCREEN_BUFFER_INFO , которая получает сведения о буфере экрана консоли.

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

Если функция выполняется успешно, возвращается ненулевое значение.

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

Замечания

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

Все координаты, возвращаемые в структуре CONSOLE_SCREEN_BUFFER_INFO, находятся в координатах ячейки символов, где источник (0, 0) находится в левом верхнем углу буфера экрана консоли.

Совет

Этот API не имеет эквивалента виртуального терминала . Его использование может по-прежнему потребоваться для приложений, которые пытаются нарисовать столбцы, сетки или заполнить отображение для получения размера окна. Это состояние окна управляется TTY/PTY/Pseudoconsole за пределами обычного потока потока и обычно считается привилегией пользователя, не настраиваемой клиентским приложением. Обновления можно получить на ReadConsoleInput.

Примеры

Пример см. в разделе "Прокрутка окна буфера экрана".

Requirements


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