Funzione GetConsoleOriginalTitle

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 originale per la finestra della console corrente.

Sintassi

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

Parametri

lpConsoleTitle [out]
Puntatore a un buffer che riceve una stringa con terminazione Null contenente il titolo originale.

nSize [in]
Dimensioni del buffer lpConsoleTitle , in caratteri.

Valore restituito

Se nSize è zero, il valore restituito è zero.

Se la funzione ha esito positivo, il valore restituito corrisponde alla lunghezza del titolo della console originale, 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 corrente, usare la funzione GetConsoleTitle.

Per compilare un'applicazione che usa questa funzione, definire _WIN32_WINNT come 0x0600 o versione successiva. Per altre informazioni, vedere Uso delle intestazioni di Windows.

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.

Requisiti

Client minimo supportato	Windows Vista [solo app desktop]
Server minimo supportato	Windows Server 2008 [solo app desktop]
Intestazione	ConsoleApi2.h (tramite WinCon.h, includere Windows.h)
Libreria	Kernel32.lib
DLL	Kernel32.dll
Nomi Unicode e ANSI	GetConsoleOriginalTitleW (Unicode) e GetConsoleOriginalTitleA (ANSI)

Vedi anche

Funzioni della console

GetConsoleTitle

SetConsoleTitle