Funzione FillConsoleOutputAttribute

Articolo
10/23/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 di carattere per un numero specificato di celle di caratteri, a partire dalle coordinate specificate in un buffer dello schermo.

Sintassi

BOOL WINAPI FillConsoleOutputAttribute(
  _In_  HANDLE  hConsoleOutput,
  _In_  WORD    wAttribute,
  _In_  DWORD   nLength,
  _In_  COORD   dwWriteCoord,
  _Out_ LPDWORD lpNumberOfAttrsWritten
);

Parametri

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

wAttribute [in]
Attributi da usare durante la scrittura nel buffer dello schermo della console. Per altre informazioni, vedere Attributi carattere.

nLength [in]
Numero di celle di caratteri da impostare sugli attributi di colore specificati.

dwWriteCoord [in]
Struttura COORD che specifica le coordinate di carattere della prima cella i cui attributi devono essere impostati.

lpNumberOfAttrsWritten [out]
Puntatore a una variabile che riceve il numero di celle di caratteri i cui attributi sono stati effettivamente impostati.

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:

Se il numero di celle di caratteri i cui attributi devono essere impostati si estende oltre la fine della riga specificata nel buffer dello schermo della console, vengono impostate le celle della riga successiva. Se il numero di celle da scrivere in si estende oltre la fine del buffer dello schermo della console, le celle vengono scritte fino alla fine del buffer dello schermo della console.

I valori di carattere nelle posizioni scritte in non vengono modificati.

Suggerimento

Questa API non è consigliata e non ha un terminale virtuale specifico equivalente. La compilazione dell'area esterna alla finestra visualizzabile non è supportata ed è riservata allo spazio cronologia del terminale. La compilazione di un'area visibile con nuovo testo o colore viene eseguita spostando il cursore, impostando i nuovi attributi, quindi scrivendo il testo desiderato per tale area, ripetendo i caratteri, se necessario per la lunghezza dell'esecuzione del riempimento. È possibile che sia necessario un movimento aggiuntivo del cursore seguito dalla scrittura del testo desiderato per riempire un'area rettangolare. L'applicazione client deve mantenere la propria memoria di ciò che si trova sullo schermo e non è in grado di eseguire query sullo stato remoto. Altre informazioni sono disponibili nella documentazione della console classica e del terminale virtuale.

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