Funzione WriteConsoleOutputCharacter
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 caratteri in celle consecutive di un buffer dello schermo della console, a partire da una posizione specificata.
Sintassi
BOOL WINAPI WriteConsoleOutputCharacter(
_In_ HANDLE hConsoleOutput,
_In_ LPCTSTR lpCharacter,
_In_ DWORD nLength,
_In_ COORD dwWriteCoord,
_Out_ LPDWORD lpNumberOfCharsWritten
);
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.
lpCharacter [in]
Caratteri da scrivere nel buffer dello schermo della console.
nLength [in]
Numero di caratteri da scrivere.
dwWriteCoord [in]
Struttura COORD che specifica le coordinate di carattere della prima cella nel buffer dello schermo della console in cui verranno scritti i caratteri.
lpNumberOfCharsWritten [out]
Puntatore a una variabile che riceve il numero di caratteri effettivamente scritti.
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 caratteri da scrivere in si estende oltre la fine della riga specificata nel buffer dello schermo della console, i caratteri vengono scritti nella riga successiva. Se il numero di caratteri da scrivere in si estende oltre la fine del buffer dello schermo della console, i caratteri vengono scritti fino alla fine del buffer dello schermo della console.
I valori degli attributi nelle posizioni scritte in non vengono modificati.
Questa funzione usa i caratteri Unicode o i caratteri a 8 bit dalla tabella codici corrente della console. Inizialmente il valore predefinito della tabella codici della console è la tabella codici OEM del sistema. Per modificare la tabella codici della console usare le funzioni SetConsoleCP o SetConsoleOutputCP. I consumer legacy possono anche usare i comandichcp o mode con cp select= ma non è consigliabile per il nuovo sviluppo.
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 generare testo in un'area senza applicare anche la formattazione del colore attiva. 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 |
Nomi Unicode e ANSI | WriteConsoleOutputCharacterW (Unicode) e WriteConsoleOutputCharacterA (ANSI) |