GetConsoleAlias-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 klassischen Konsolendokument im Vergleich zum virtuellen Terminal .
Ruft den Text für den angegebenen Konsolenalias und die ausführbare Datei ab.
Syntax
DWORD WINAPI GetConsoleAlias(
_In_ LPTSTR lpSource,
_Out_ LPTSTR lpTargetBuffer,
_In_ DWORD TargetBufferLength,
_In_ LPTSTR lpExeName
);
Parameter
lpSource [in]
Der Konsolenalias, dessen Text abgerufen werden soll.
lpTargetBuffer [out]
Ein Zeiger auf einen Puffer, der den dem Konsolenalias zugeordneten Text empfängt.
TargetBufferLength [in]
Die Größe des Puffers verweist auf den lpTargetBuffer in Bytes.
lpExeName [in]
Der Name der ausführbaren Datei.
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
Um eine Anwendung zu kompilieren, die diese Funktion verwendet, definieren Sie _WIN32_WINNT als 0x0501 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 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 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 | GetConsoleAliasW (Unicode) und GetConsoleAliasA (ANSI) |