Funzione SetConsoleCursorInfo
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 le dimensioni e la visibilità del cursore per il buffer dello schermo della console specificato.
Sintassi
BOOL WINAPI SetConsoleCursorInfo(
_In_ HANDLE hConsoleOutput,
_In_ const CONSOLE_CURSOR_INFO *lpConsoleCursorInfo
);
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.
lpConsoleCursorInfo [in]
Puntatore a una struttura CONSOLE_CURSOR_INFO che fornisce le nuove specifiche per il cursore del 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:
Quando il cursore di un buffer dello schermo è visibile, l'aspetto può variare, dal riempimento completo di una cella di caratteri alla visualizzazione come linea orizzontale nella parte inferiore della cella. Il membro dwSize della struttura CONSOLE_CURSOR_INFO specifica la percentuale di una cella di caratteri riempita dal cursore. Se questo membro è minore di 1 o maggiore di 100, SetConsoleCursorInfo ha esito negativo.
Suggerimento
Questa API ha un terminale virtuale equivalente nella sezione relativa alla visibilità del cursore con le ^[[?25h sequenze e .^[[?25l
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 |