GetConsoleOriginalTitle-Funktion

  • Artikel

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 ursprünglichen Titel für das aktuelle Konsolenfenster ab.

Syntax

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

Parameter

lpConsoleTitle [out]
Ein Zeiger auf einen Puffer, der eine mit Null beendete Zeichenfolge mit dem ursprünglichen Titel empfängt.

nSize [in]
Größe des IpConsolenPuffers in Zeichen.

Rückgabewert

Wenn nSize null ist, ist der Rückgabewert null.

Wenn die Funktion erfolgreich ist, ist der Rückgabewert die Länge des ursprünglichen Konsolentitels in Zeichen.

Wenn die Funktion fehlerhaft ist, wird der Fehlercode und GetLastError als Rückgabewert ausgegeben.

Hinweise

Verwenden Sie die SetConsoleTitle-Funktion , um den Titel für ein Konsolenfenster festzulegen. Verwenden Sie die GetConsoleTitle-Funktion, um die aktuelle Titelzeichenfolge abzurufen.

Um eine Anwendung zu kompilieren, die diese Funktion verwendet, definieren Sie _WIN32_WINNT als 0x0600 oder höher. Weitere Informationen finden Sie unter Verwenden der Windows-Header.

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.

Anforderungen

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

Siehe auch

Konsolenfunktionen

GetConsoleTitle

SetConsoleTitle