SetConsoleHistoryInfo-Funktion
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 Dokument klassische Konsole im Vergleich zum virtuellen Terminal.
Legt die Verlaufseinstellungen für die Konsole des Aufrufvorgangs fest.
Syntax
BOOL WINAPI SetConsoleHistoryInfo(
_In_ PCONSOLE_HISTORY_INFO lpConsoleHistoryInfo
);
Parameter
lpConsoleHistoryInfo [in]
Ein Zeiger auf eine CONSOLE_HISTORY_INFO Struktur, die die Verlaufseinstellungen für die Konsole des Prozesses enthält.
Rückgabewert
Wenn die Funktion erfolgreich ist, ist 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 Konsolenprozess ist, schlägt die Funktion fehl und legt den letzten Fehlercode auf ERROR_ACCESS_DENIED fest.
Tipp
Diese API wird nicht empfohlen und verfügt nicht über eine virtuelle Terminal-Entsprechung. 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, Standard. 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 | ConsoleApi3.h (über WinCon.h, Windows.h einschließen) |
| Bibliothek | Kernel32.lib |
| DLL | Kernel32.dll |