Fonction GetConsoleAliases
Important
Ce document décrit les fonctionnalités de la plateforme de la console qui ne font plus partie de la feuille de route de notre écosystème. Nous vous déconseillons d’utiliser ce contenu dans de nouveaux produits, mais nous continuerons à prendre en charge des utilisations existantes pour l’avenir indéterminé. Notre solution moderne préférée se concentre sur les séquences de terminaux virtuels pour une compatibilité maximale dans les scénarios multiplateformes. Vous trouverez plus d’informations sur cette décision de conception dans notre document sur les consoles classiques et les terminaux virtuels.
Récupère tous les alias de console définis pour l’exécutable spécifié.
Syntaxe
DWORD WINAPI GetConsoleAliases(
_Out_ LPTSTR lpAliasBuffer,
_In_ DWORD AliasBufferLength,
_In_ LPTSTR lpExeName
);
Paramètres
lpAliasBuffer [sortie]
Un pointeur vers une mémoire tampon qui reçoit les alias.
Le format des données est le suivant : Source1=Target1\0Source2=Target2\0... SourceN=TargetN\0, où N correspond au nombre d’alias de console définis.
AliasBufferLength [sortie]
La taille de la mémoire tampon pointée par la fonction lpAliasBuffer, en octets.
lpExeName [entrée]
Le fichier exécutable dont les alias doivent être récupérés.
Valeur renvoyée
Si la fonction réussit, la valeur de retour est différente de zéro.
Si la fonction échoue, la valeur de retour est égale à zéro. Pour obtenir des informations détaillées sur l’erreur, appelez GetLastError.
Notes
Pour déterminer la taille requise de la mémoire tampon lpExeName, utilisez la fonction GetConsoleAliasesLength.
Pour compiler une application qui utilise cette fonction, définissez _WIN32_WINNT sur 0x0501 ou une version ultérieure. Pour plus d’informations, consultez Utilisation des en-têtes Windows.
Conseil
Cette API n’est pas recommandée et n’a pas d’équivalent de terminal virtuel. Cette décision aligne intentionnellement la plateforme Windows avec d’autres systèmes d’exploitation où l’application cliente individuelle agissant en tant que shell ou interpréteur est censée maintenir ses propres fonctionnalités pratiques pour l’utilisateur, telles que la lecture de lignes et le comportement de manipulation, y compris les alias et l’historique des commandes. La communication à distance des applications via des utilitaires multiplateformes et des transports comme SSH peut ne pas fonctionner comme prévu si vous utilisez cette API.
Spécifications
| Client minimal pris en charge | Windows 2000 Professionnel [applications de bureau uniquement] |
| Serveur minimal pris en charge | Windows 2000 Server [applications de bureau uniquement] |
| En-tête | ConsoleApi3.h (via WinCon.h, include Windows.h) |
| Bibliothèque | Kernel32.lib |
| DLL | Kernel32.dll |
| Noms Unicode et ANSI | GetConsoleAliasesW (Unicode) et GetConsoleAliasesA (ANSI) |