GetConsoleTitle-Funktion

Artikel
12/21/2023

Wichtig

In diesem Dokument werden Konsolenplattformfunktionen beschrieben, die nicht mehr Teil unserer Ökosystem-Roadmap sind. Wir empfehlen nicht, diesen Inhalt in neuen Produkten zu verwenden, aber wir werden weiterhin vorhandene Nutzungen für die unbegrenzte Zukunft unterstützen. Unsere bevorzugte moderne Lösung konzentriert sich auf virtuelle Terminalsequenzen für maximale Kompatibilität in plattformübergreifenden Szenarien. Weitere Informationen zu dieser Designentscheidung finden Sie in unserem klassischen Konsolendokument im Vergleich zum virtuellen Terminal .

Ruft den Titel für das aktuelle Konsolenfenster ab.

Syntax

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

Parameter

lpConsoleTitle [out]
Ein Zeiger auf einen Puffer, der eine mit Null beendete Zeichenfolge mit dem Titel empfängt. Wenn der Puffer zu klein ist, um den Titel zu speichern, speichert die Funktion so viele Zeichen des Titels, wie sie in den Puffer passen, und endet mit einem Null-Terminator.

nSize [in]
Die Größe des Puffers, auf den der lpConsoleTitle-Parameter in Zeichen verweist.

Rückgabewert

Wenn die Funktion erfolgreich ist, ist der Rückgabewert die Länge des Titels des Konsolenfensters in Zeichen.

Wenn die Funktion fehlerhaft ist, ist der Rückgabewert null und GetLastError gibt den Fehlercode zurück.

Hinweise

Verwenden Sie die SetConsoleTitle-Funktion , um den Titel für ein Konsolenfenster festzulegen. Verwenden Sie die GetConsoleOriginalTitle-Funktion, um die ursprüngliche Titelzeichenfolge abzurufen.

Diese Funktion verwendet entweder Unicodezeichen oder 8-Bit-Zeichen aus der aktuellen Codepage der Konsole. Die Codepage der Konsole wird zunächst standardmäßig auf die OEM-Codepage des Systems festgelegt. Um die Codepage der Konsole zu ändern, verwenden Sie die Funktionen SetConsoleCP oder SetConsoleOutputCP. Ältere Consumer können auch die chcp oder mode con cp select=-Befehle verwenden, aber sie werden für neue Entwicklungen nicht empfohlen.

Tipp

Diese API wird nicht empfohlen und verfügt nicht über eine virtuelle Terminalentsprechung. Diese Entscheidung richtet die Windows-Plattform absichtlich mit anderen Betriebssystemen aus. Anwendungen, die über plattformübergreifende Dienstprogramme und Transporte wie SSH remoten, funktionieren möglicherweise nicht wie erwartet, wenn Sie diese API verwenden.

Beispiele

Ein Beispiel finden Sie unter SetConsoleTitle.

Anforderungen


Unterstützte Mindestversion (Client)	Windows 2000 Professional [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows 2000 Server [nur Desktop-Apps]
Header	ConsoleApi.h (über WinCon.h, Windows.h einschließen)
Bibliothek	Kernel32.lib
DLL	Kernel32.dll
Unicode- und ANSI-Namen	GetConsoleTitleW (Unicode) und GetConsoleTitleA (ANSI)