Funzione WriteConsoleOutputAttribute

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.

Copia un numero di attributi di carattere in celle consecutive di un buffer dello schermo della console, a partire da una posizione specificata.

Sintassi

BOOL WINAPI WriteConsoleOutputAttribute(
  _In_        HANDLE  hConsoleOutput,
  _In_  const WORD    *lpAttribute,
  _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.

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

nLength [in]
Numero di celle di caratteri del buffer dello schermo in cui verranno copiati gli attributi.

dwWriteCoord [in]
Struttura COORD che specifica le coordinate di carattere della prima cella nel buffer dello schermo della console in cui verranno scritti gli attributi.

lpNumberOfAttrsWritten [out]
Puntatore a una variabile che riceve il numero di attributi effettivamente scritti nel buffer dello schermo della console.

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 attributi da scrivere in si estende oltre la fine della riga specificata nel buffer dello schermo della console, gli attributi vengono scritti nella riga successiva. Se il numero di attributi da scrivere in si estende oltre la fine del buffer dello schermo della console, gli attributi vengono scritti fino alla fine del buffer dello schermo della console.

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

Suggerimento

Questa API ha un terminale virtuale equivalente nella formattazione del testo e nelle sequenze di posizionamento del cursore. Spostare il cursore nella posizione in cui inserire, applicare la formattazione desiderata e scrivere testo da riempire. Non esiste alcun equivalente per applicare il colore a un'area senza emettere testo. Questa decisione allinea intenzionalmente la piattaforma Windows ad altri sistemi operativi in cui si prevede che l'applicazione client ricordi il proprio stato disegnato per ulteriori modifiche.

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