Função SetConsoleTextAttribute

Artigo
12/15/2023

Importante

Este documento descreve a funcionalidade da plataforma do console que não faz mais parte do nosso roteiro de ecossistema. Não recomendamos o uso desse conteúdo em novos produtos, mas continuaremos a oferecer suporte aos usos existentes por tempo indeterminado. Nossa solução moderna preferida se concentra em sequências de terminais virtuais para máxima compatibilidade em cenários de multiplataforma. Você pode encontrar mais informações sobre essa decisão de design em nosso documento Console clássico versus terminal virtual.

Define os atributos dos caracteres gravados no buffer de tela do console pela função WriteFile ou WriteConsole ou ecoados pela função ReadFile ou ReadConsole. Essa função afeta o texto escrito após a chamada da função.

Sintaxe

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

Parâmetros

hConsoleOutput [in]
Um identificador do buffer da tela do console. O identificador deve ter o direito de acesso GENERIC_READ. Para saber mais, confira Segurança de buffer e direitos de acesso do console.

wAttributes [entrada]
Os atributos de caracteres.

Valor retornado

Se a função for bem-sucedida, o valor retornado será diferente de zero.

Se a função falhar, o valor retornado será zero. Para obter informações de erro estendidas, chame GetLastError.

Comentários

Para determinar os atributos de cor atuais de um buffer de tela, use a função GetConsoleScreenBufferInfo.

Dica

Essa API tem um terminal virtual equivalente nas sequências de formatação de texto. Sequências de terminais virtuais são recomendadas para todo o desenvolvimento novo e em andamento.

Exemplos

Para ver um exemplo, consulte Usar as funções de entrada e saída de alto nível.

Requisitos


Cliente mínimo com suporte	Windows 2000 Professional [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows 2000 Server [somente aplicativos da área de trabalho]
Cabeçalho	ConsoleApi2.h (via WinCon.h, inclui o Windows.h)
Biblioteca	Kernel32.lib
DLL	Kernel32.dll