Lire en anglais

Partager via


Fonction GetConsoleAlias

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 le texte de l’alias de console et de l’exécutable spécifiés.

Syntaxe

DWORD WINAPI GetConsoleAlias(
  _In_  LPTSTR lpSource,
  _Out_ LPTSTR lpTargetBuffer,
  _In_  DWORD  TargetBufferLength,
  _In_  LPTSTR lpExeName
);

Paramètres

lpSource [entrée]
L’alias de console dont le texte doit être récupéré.

lpTargetBuffer [sortie]
Un pointeur vers une mémoire tampon qui reçoit le texte associé à l’alias de console.

TargetBufferLength [entrée]
La taille de la mémoire tampon pointée par la fonction lpTargetBuffer, en octets.

lpExeName [entrée]
Le nom du fichier exécutable.

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 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 GetConsoleAliasW (Unicode) et GetConsoleAliasA (ANSI)

Voir aussi

Alias d’une console

Fonctions de console

AddConsoleAlias

GetConsoleAliases

GetConsoleAliasExes