GetConsoleHistoryInfo-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 die Verlaufseinstellungen für die Konsole des Aufrufvorgangs ab.

Syntax

BOOL WINAPI GetConsoleHistoryInfo(
  _Out_ PCONSOLE_HISTORY_INFO lpConsoleHistoryInfo
);

Parameter

lpConsoleHistoryInfo [out]
Ein Zeiger auf eine CONSOLE_HISTORY_INFO-Struktur , welche die Verlaufseinstellungen für die Konsole des Aufrufvorgangs empfängt.

Rückgabewert

Wenn die Funktion erfolgreich ist, wird der Rückgabewert ungleich Null.

Wenn die Funktion fehlerhaft ist, ist der Rückgabewert null. Um erweiterte Fehlerinformationen zu erhalten, rufen Sie GetLastError auf.

Hinweise

Wenn der aufrufende Prozess kein Konsolenvorgang ist, schlägt die Funktion fehl und legt den letzten Fehler auf ERROR_ACCESS_DENIED fest.

Tipp

Diese API wird nicht empfohlen und verfügt nicht über eine virtuelle Terminalentsprechung. Diese Entscheidung richtet die Windows-Plattform absichtlich an andere Betriebssysteme aus, bei denen die einzelne Clientanwendung als Shell oder Dolmetscher erwartet wird, dass sie ihre eigenen Benutzerfreundlichkeitsfunktionen wie Zeilenlese- und Manipulationsverhalten, einschließlich Aliase und Befehlsverlauf beibehalten. 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]
Minimal unterstützter Server Windows Server 2008 [nur Desktop-Apps]
Header ConsoleApi3.h (über WinCon.h, Windows.h einschließen)
Bibliothek Kernel32.lib
DLL Kernel32.dll

Siehe auch

Konsolenfunktionen

CONSOLE_HISTORY_INFO

SetConsoleHistoryInfo