Fonction GetConsoleOriginalTitle
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 titre d’origine de la fenêtre de console actuelle.
Syntaxe
DWORD WINAPI GetConsoleOriginalTitle(
_Out_ LPTSTR lpConsoleTitle,
_In_ DWORD nSize
);
Paramètres
lpConsoleTitle [sortie]
Un pointeur sur une mémoire tampon qui reçoit une chaîne de caractères à terminaison nulle contenant le titre original.
nSize [sortie]
La taille de la mémoire tampon lpConsoleTitle, en caractères.
Valeur renvoyée
Si nSize est égal à zéro, la valeur renvoyée est égale à zéro.
Si la fonction aboutit, la valeur renvoyée est la longueur du titre de la console d’origine, en caractères.
Si la fonction échoue, la valeur renvoyée est zéro et GetLastError renvoie le code d'erreur.
Notes
Pour définir le titre d'une fenêtre de console, utilisez la fonction SetConsoleTitle. Pour récupérer la chaîne de titre actuelle, utilisez la fonction GetConsoleTitle.
Pour compiler une application qui utilise cette fonction, définissez _WIN32_WINNT sur 0x0600 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. 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 Vista [applications de bureau uniquement] |
| Serveur minimal pris en charge | Windows Server 2008 [applications de bureau uniquement] |
| En-tête | ConsoleApi2.h (via WinCon.h, include Windows.h) |
| Bibliothèque | Kernel32.lib |
| DLL | Kernel32.dll |
| Noms Unicode et ANSI | GetConsoleOriginalTitleW (Unicode) et GetConsoleOriginalTitleA (ANSI) |