Funzione SetConsoleTextAttribute

Articolo
12/13/2023

Importante

Questo documento descrive le funzionalità della piattaforma della console che non fanno più parte della roadmap dell'ecosistema. Non è consigliabile usare questo contenuto nei nuovi prodotti, ma continueremo a supportare gli utilizzi esistenti per il futuro indefinito. La soluzione moderna preferita è incentrata sulle sequenze di terminale virtuale per garantire la massima compatibilità negli scenari multipiattaforma. Per altre informazioni su questa decisione di progettazione, vedere il documento relativo alla console classica e al terminale virtuale.

Imposta gli attributi dei caratteri scritti nel buffer dello schermo della console dalla funzione WriteFile o WriteConsole oppure restituiti dalla funzione ReadFile o ReadConsole. Questa funzione influisce sul testo scritto dopo la chiamata di funzione.

Sintassi

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

Parametri

hConsoleOutput [in]
Handle per il buffer dello schermo della console. L'handle deve avere il diritto di accesso GENERIC_READ . Per altre informazioni, vedere Sicurezza dei buffer della console e diritti di accesso.

wAttributes [in]
Attributi di carattere.

Valore restituito

Se la funzione ha esito positivo, il valore restituito è diverso da zero.

Se la funzione ha esito negativo, il valore restituito è zero. Per informazioni dettagliate sull'errore, chiamare GetLastError.

Osservazioni:

Per determinare gli attributi di colore correnti di un buffer dello schermo, chiamare la funzione GetConsoleScreenBufferInfo.

Suggerimento

Questa API ha un terminale virtuale equivalente nelle sequenze di formattazione del testo. Le sequenze di terminale virtuale sono consigliate per tutti gli sviluppi nuovi e in corso.

Esempi

Per un esempio, vedere Uso delle funzioni di input e output di alto livello.

Requisiti


Client minimo supportato	Windows 2000 Professional [solo app desktop]
Server minimo supportato	Windows 2000 Server [solo app desktop]
Intestazione	ConsoleApi2.h (tramite WinCon.h, includere Windows.h)
Libreria	Kernel32.lib
DLL	Kernel32.dll