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

Ruft alle definierten Konsolenalias für die angegebene ausführbare Datei ab.

Syntax

DWORD WINAPI GetConsoleAliases(
  _Out_ LPTSTR lpAliasBuffer,
  _In_  DWORD  AliasBufferLength,
  _In_  LPTSTR lpExeName
);

Parameter

lpAliasBuffer [out]
Ein Zeiger auf einen Puffer, der die Aliase empfängt.

Das Format der Daten lautet wie folgt: Source1 Target1=\0Source2 Target2=\0... SourceN TargetN=\0, wobei N die Anzahl der definierten Konsolenalias ist.

AliasBufferLength [in]
Die Größe des Puffers, auf den lpAliasBuffer in Bytes verweist.

lpExeName [in]
Die ausführbare Datei, deren Aliase abgerufen werden sollen.

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

Verwenden Sie die GetConsoleAliasesLength-Funktion, um die erforderliche Größe für den lpExeName-Puffer zu ermitteln.

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	GetConsoleAliasesW (Unicode) und GetConsoleAliasesA (ANSI)