Funzione GetConsoleTitle

Articolo
10/23/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.

Recupera il titolo per la finestra della console corrente.

Sintassi

DWORD WINAPI GetConsoleTitle(
  _Out_ LPTSTR lpConsoleTitle,
  _In_  DWORD  nSize
);

Parametri

lpConsoleTitle [out]
Puntatore a un buffer che riceve una stringa con terminazione Null contenente il titolo. Se il buffer è troppo piccolo per archiviare il titolo, la funzione archivia il numero di caratteri del titolo nel buffer, terminando con un carattere di terminazione Null.

nSize [in]
Dimensioni del buffer a cui punta il parametro lpConsoleTitle , in caratteri.

Valore restituito

Se la funzione ha esito positivo, il valore restituito è la lunghezza del titolo della finestra della console, in caratteri.

Se la funzione ha esito negativo, il valore restituito è zero e GetLastError restituisce il codice di errore.

Osservazioni:

Per impostare il titolo per una finestra della console, usare la funzione SetConsoleTitle. Per recuperare la stringa del titolo originale, usare la funzione GetConsoleOriginalTitle.

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 non è consigliata e non ha un terminale virtuale equivalente. Questa decisione allinea intenzionalmente la piattaforma Windows ad altri sistemi operativi. Le applicazioni remote tramite utilità multipiattaforma e trasporti come SSH potrebbero non funzionare come previsto se si usa questa API.

Esempi

Per un esempio, vedere SetConsoleTitle.

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	GetConsoleTitleW (Unicode) e GetConsoleTitleA (ANSI)