Функция WriteConsoleOutputAttribute

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

Синтаксис

BOOL WriteConsoleOutputAttribute(

HANDLE hConsoleOutput,         // дескриптор экранного буфера
CONST WORD
* lpAttribute,      // атрибуты записи
DWORD
nLength,                 // число ячеек
COORD
dwWriteCoord,            // координаты первой ячейки
LPDWORD
lpNumberOfAttrsWritten // число записанных ячеек

);

Параметры

hConsoleOutput

[in] Дескриптор экранного буфера консоли. Дескриптор должен иметь право доступа GENERIC_READ. Для получения дополнительной информации, см. статью Защита буфера и права доступа в консоли.

lpAttribute

[in] Указатель на буфер, который содержит атрибуты, которые используются при записи в экранный буфер консоли. Для получения дополнительной информации, см. статью Атрибуты символа.

nLength

[in] Число символьных знакомест экранного буфера, в которые атрибуты должны быть скопированы. Общее количество должно быть меньше чем 64КБ.

dwWriteCoord

[in] Структура COORD, которая устанавливает координаты первой ячейки в экранном буфере консоли, в которую атрибуты должны быть записаны.

lpNumberOfAttrsWritten

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

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

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

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

Замечания

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

Символьные значения в позициях записи не изменяются.

Код примера

Пример смотри в статье Запись символов или цветов в последовательные ячейки.

Смотри также

Обзор консольных приложений, Функции консоли, COORD, ReadConsoleOutput, ReadConsoleOutputAttribute, ReadConsoleOutputCharacter, WriteConsoleOutput, WriteConsoleOutputCharacter

Размещение и совместимость WriteConsoleOutputAttribute

Windows. NET Server

Да

Windows XP

Да

Windows 2000

Да

Windows NT

Да

Windows Me

Да

Windows 98

Да

Windows 95

Да

Используемая библиотека

Kernel32.lib

Заголовочный файл

 

- объявлено в

Wincon.h

- включено в

Windows.h

Unicode

Нет

Замечания по платформе

Не имеется

 

Назад в оглавление
На главную страницу
На оглавление справки

Hosted by uCoz