Funzione SetConsoleCursorPosition

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 la posizione del cursore nel buffer dello schermo della console specificato.

Sintassi

BOOL WINAPI SetConsoleCursorPosition(
  _In_ HANDLE hConsoleOutput,
  _In_ COORD  dwCursorPosition
);

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.

dwCursorPosition [in]
Struttura COORD che specifica la nuova posizione del cursore, espressa in caratteri. Le coordinate sono la colonna e la riga di una cella di caratteri del buffer dello schermo. Le coordinate devono essere entro i limiti 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:

La posizione del cursore determina dove vengono visualizzati i caratteri scritti dalla funzione WriteFile o WriteConsole o restituiti dalla funzione ReadFile o ReadConsole. Per determinare la posizione corrente del cursore, utilizzare la funzione GetConsoleScreenBufferInfo.

Se la nuova posizione del cursore non rientra nei limiti della finestra del buffer dello schermo della console, l'origine della finestra cambia per rendere visibile il cursore.

Suggerimento

Questa API ha un terminale virtuale equivalente nelle sezioni semplici di posizionamento del cursore e posizionamento del cursore. L'uso delle sequenze di controllo newline, ritorno a capo, backspace e tabulazione può essere utile anche per il posizionamento del cursore.

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