Функция ReadConsoleOutputAttribute

Статья
10/23/2023

Важно!

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

Копирует указанное количество атрибутов символов из последовательных ячеек буфера экрана консоли, начиная с указанного расположения.

Синтаксис

BOOL WINAPI ReadConsoleOutputAttribute(
  _In_  HANDLE  hConsoleOutput,
  _Out_ LPWORD  lpAttribute,
  _In_  DWORD   nLength,
  _In_  COORD   dwReadCoord,
  _Out_ LPDWORD lpNumberOfAttrsRead
);

Параметры

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

lpAttribute [out]
Указатель на буфер, который получает атрибуты, используемые буфером экрана консоли.

Дополнительные сведения см. в разделе "Атрибуты символов".

nLength [in]
Количество ячеек буфера экрана, из которых следует читать. Размер буфера, на который указывает параметр lpAttribute , должен быть nLength * sizeof(WORD).

dwReadCoord [in]
Координаты первой ячейки в буфере экрана консоли, из которой следует читать символы. Элемент X структуры COORD — это столбец, а элемент Y — строка.

lpNumberOfAttrsRead [out]
Указатель на переменную, которая получает количество фактически считываемых атрибутов.

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

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

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

Замечания

Если число атрибутов, считываемых из строки буфера экрана, выходит за пределы указанной строки буфера экрана, атрибуты считываются из следующей строки. Если число атрибутов, считываемых из буфера экрана консоли, выходит за пределы буфера экрана консоли, считываются атрибуты до конца буфера экрана консоли.

Совет

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

Requirements


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