Funzione GetConsoleScreenBufferInfo

Articolo
10/23/2023

Recupera informazioni sul buffer dello schermo della console specificato.

Sintassi

BOOL WINAPI GetConsoleScreenBufferInfo(
  _In_  HANDLE                      hConsoleOutput,
  _Out_ PCONSOLE_SCREEN_BUFFER_INFO lpConsoleScreenBufferInfo
);

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.

lpConsoleScreenBufferInfo [out]
Puntatore a una struttura CONSOLE_SCRedizione EnterpriseN_BUFFER_INFO che riceve le informazioni sul 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:

Il rettangolo restituito nel membro srWindow della struttura CONSOLE_SCRedizione EnterpriseN_BUFFER_INFO può essere modificato e quindi passato alla funzione SetConsoleWindowInfo per scorrere il buffer dello schermo della console nella finestra, per modificare le dimensioni della finestra o entrambi.

Tutte le coordinate restituite nella struttura CONSOLE_SCRedizione EnterpriseN_BUFFER_INFO si trovano in coordinate di cella di caratteri, dove l'origine (0, 0) si trova nell'angolo superiore sinistro del buffer dello schermo della console.

Suggerimento

Questa API non ha un terminale virtuale equivalente. L'uso può comunque essere necessario per le applicazioni che tentano di disegnare colonne, griglie o riempire la visualizzazione per recuperare le dimensioni della finestra. Questo stato della finestra viene gestito dalla TTY/PTY/Pseudoconsole al di fuori del flusso normale ed è generalmente considerato un privilegio utente non modificabile dall'applicazione client. Aggiornamenti possono essere ricevuti ReadConsoleInput.

Esempi

Per un esempio, vedere Scorrimento della finestra di un buffer dello schermo.

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