Функция
ReadConsoleOutputAttributeФункция
ReadConsoleOutputAttribute копирует заданное число атрибутов символа из последовательных ячеек экранного буфера консоли, начинающихся в заданном месте.Синтаксис
BOOL ReadConsoleOutputAttribute( hConsoleOutput, // дескриптор экранного буфера LPWORD lpAttribute, // буфер атрибутов DWORD nLength, // число ячеек для чтения COORD dwReadCoord, // координаты первой ячейки LPDWORD lpNumberOfAttrsRead // число прочитанных ячеек ); |
Параметры
hConsoleOutput
[in] Дескриптор экранного буфера консоли. Дескриптор должен иметь право доступа
GENERIC_READ. Для получения дополнительной информации, см. статью Защита буфера и права доступа в консоли.lpAttribute
[out] Указатель на буфер, который принимает атрибуты, используемые экранным буфером консоли. Общий требуемый размер должен быть меньше чем 64КБ.
Для получения дополнительной информации, см.
Атрибуты символовnLength
[in] Число символьных знакомест экранного буфера для чтения. Размер буфера, указанного
параметром lpAttribute должен быть nLength * sizeof (WORD).dwReadCoord
[in] Координаты первой ячейки для чтения в экранном буфере консоли.
Член X структуры COORD - это колонка, а член Y - строка.lpNumberOfAttrsRead
[out] Указатель на переменную, которая получает число фактически прочитанных атрибутов.
Возвращаемые значения
Если функция завершается успешно, величина возвращаемого значения - не ноль.
Если функция завершается с ошибкой, величина возвращаемого значения - ноль. Чтобы получать расширенные данные об ошибках, вызовите
функцию GetLastError.Замечания
Если число атрибутов, которые нужно прочитать выходит за пределы конца заданной строки экранного буфера, атрибуты читаются из следующего ряда. Если число атрибутов, которое нужно прочитать выходит за пределы конца экранного буфера консоли, атрибуты читаются до конца экранного буфера консоли.
Смотри также
Обзор консольных приложений, Функции консоли, COORD, ReadConsoleOutput, ReadConsoleOutputCharacter, WriteConsoleOutput, WriteConsoleOutputAttribute, WriteConsoleOutputCharacter
Размещение и совместимость ReadConsoleOutputAttribute |
|
Windows. NET Server |
Да |
Windows XP |
Да |
Windows 2000 |
Да |
Windows NT |
Да |
Windows Me |
Да |
Windows 98 |
Да |
Windows 95 |
Да |
Используемая библиотека |
Kernel32.lib |
Заголовочный файл |
|
- объявлено в |
Wincon.h |
- включено в |
Windows.h |
Unicode |
Нет |
Замечания по платформе |
Не имеется |