Fonction GetConsoleTitle

Article
12/22/2023

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 de la fenêtre de la console actuelle.

Syntaxe

DWORD WINAPI GetConsoleTitle(
  _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. Si la mémoire tampon est trop petite pour stocker le titre, la fonction stocke autant de caractères du titre que la mémoire tampon peut en contenir, en terminant par un terminateur nul.

nSize [sortie]
La taille de la mémoire tampon indiquée par le paramètre lpConsoleTitle, en caractères.

Valeur renvoyée

Si la fonction aboutit, la valeur renvoyée est la longueur du titre de la fenêtre de console, 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 d’origine, utilisez la fonction GetConsoleOriginalTitle.

Cette fonction utilise des caractères Unicode ou des caractères 8 bits de la page de codes actuelle de la console. Par défaut, la page de codes de la console est initialement définie sur la page de codes OEM du système. Pour changer la page de codes de la console, utilisez les fonctions SetConsoleCP ou SetConsoleOutputCP. Les consommateurs existants peuvent également utiliser les commandes chcp ou mode con cp select=, mais ce n’est pas recommandé pour un nouveau développement.

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.

Exemples

Pour obtenir un exemple, consultez SetConsoleTitle.

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	ConsoleApi2.h (via WinCon.h, include Windows.h)
Bibliothèque	Kernel32.lib
DLL	Kernel32.dll
Noms Unicode et ANSI	GetConsoleTitleW (Unicode) et GetConsoleTitleA (ANSI)