AddConsoleAlias-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 .

Definiert einen Konsolenalias für die angegebene ausführbare Datei.

Syntax

BOOL WINAPI AddConsoleAlias(
  _In_ LPCTSTR Source,
  _In_ LPCTSTR Target,
  _In_ LPCTSTR ExeName
);

Parameter

Quelle in
Der Konsolenalias, der dem durch Target angegebenen Text zugeordnet werden soll.

Ziel in
Der Text, der durch "Source" ersetzt werden soll. Wenn dieser Parameter NULL ist, wird der Konsolenalias entfernt.

ExeName [in]
Der Name der ausführbaren Datei, für die der Konsolenalias definiert werden soll.

Rückgabewert

Wenn die Funktion erfolgreich ist, lautet der Rückgabewert WAHR (0).

Wenn die Funktion fehlerhaft ist, ist der Rückgabewert FALSCH. 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.

Beispiele

Ein Beispiel hierfür ist Console Aliases.

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	AddConsoleAliasW (Unicode) und AddConsoleAliasA (ANSI)