Функция SetConsoleTextAttribute

Статья
12/13/2023

Важно!

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

Задает атрибуты символов, записанных в буфер экрана консоли с помощью функции WriteFile или WriteConsole, или от имени функции ReadFile или ReadConsole. Эта функция влияет на текст, написанный после вызова функции.

Синтаксис

BOOL WINAPI SetConsoleTextAttribute(
  _In_ HANDLE hConsoleOutput,
  _In_ WORD   wAttributes
);

Параметры

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

wAttributes [in]
Атрибуты символов.

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

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

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

Замечания

Чтобы определить текущие атрибуты цвета буфера экрана, вызовите функцию GetConsoleScreenBufferInfo .

Совет

Этот API имеет эквивалент виртуального терминала в последовательностях форматирования текста. Для всех новых и текущих разработок рекомендуется использовать последовательности виртуальных терминалов .

Примеры

Пример см. в разделе "Использование высокоуровневых входных и выходных функций".

Requirements


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