Fonction SetConsoleTextAttribute
Important
Ce document décrit les fonctionnalités de la plateforme de console qui ne font plus partie de notre feuille de route de l’é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 terminal virtuel pour une compatibilité maximale dans les scénarios multiplateformes. Vous trouverez plus d’informations sur cette décision de conception dans notre document console classique versus terminal virtuel.
Définit les attributs des caractères écrits dans la mémoire tampon de l’écran de la console par la fonction WriteFile ou WriteConsole, ou écrits par écho par la fonction ReadFile ou ReadConsole. Cette fonction affecte le texte écrit après l’appel de fonction.
Syntaxe
BOOL WINAPI SetConsoleTextAttribute(
_In_ HANDLE hConsoleOutput,
_In_ WORD wAttributes
);
Paramètres
hConsoleOutput [entrée]
Handle vers la mémoire tampon d’écran de console. Le handle doit avoir le droit d’accès GENERIC_READ. Pour plus d’informations, consultez Sécurité de la mémoire tampon et droits d’accès d’une console.
wAttributes [entrée]
Les attributs de caractères.
Valeur retourné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 les attributs de couleur actuels d’une mémoire tampon d’écran, appelez la fonction GetConsoleScreenBufferInfo.
Conseil
Cette API a un équivalent au terminal virtuel dans les séquences de mise en forme du texte. Les séquences de terminal virtuel sont recommandées pour tout développement nouveau et continu.
Exemples
Pour obtenir un exemple, consultez Utilisation des fonctions d’entrée et de sortie de haut niveau.
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, inclure Windows.h) |
| Bibliothèque | Kernel32.lib |
| DLL | Kernel32.dll |