Fonction AddConsoleAlias
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.
Définit un alias de console pour l’exécutable spécifié.
Syntaxe
BOOL WINAPI AddConsoleAlias(
_In_ LPCTSTR Source,
_In_ LPCTSTR Target,
_In_ LPCTSTR ExeName
);
Paramètres
Source [in]
L'alias de console à associer au texte spécifié par Target.
Target [entrée]
Texte à remplacer par Source. Si ce paramètre a la valeur NUL, l’alias de console est supprimé.
ExeName [entrée]
Nom du fichier exécutable pour lequel l’alias de console doit être défini.
Valeur renvoyée
Si la fonction aboutit, la valeur renvoyée est VRAI.
Si la fonction échoue, la valeur renvoyée est FAUX. Pour obtenir des informations détaillées sur l’erreur, appelez GetLastError.
Notes
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.
Exemples
Pour obtenir un exemple, consultez Alias de console.
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, inclure Windows.h) |
| Bibliothèque | Kernel32.lib |
| DLL | Kernel32.dll |
| Noms Unicode et ANSI | AddConsoleAliasW (Unicode) et AddConsoleAliasA (ANSI) |