Fonction WriteConsoleOutputAttribute
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.
Copie un certain nombre d’attributs de caractères dans des cellules consécutives d’une mémoire tampon d’écran de console, en commençant à un emplacement spécifié.
Syntaxe
BOOL WINAPI WriteConsoleOutputAttribute(
_In_ HANDLE hConsoleOutput,
_In_ const WORD *lpAttribute,
_In_ DWORD nLength,
_In_ COORD dwWriteCoord,
_Out_ LPDWORD lpNumberOfAttrsWritten
);
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_WRITE. Pour plus d’informations, consultez Sécurité de la mémoire tampon et droits d’accès d’une console.
lpAttribute [entrée]
Attributs à utiliser lors de l’écriture dans la mémoire tampon de l’écran de console. Pour plus d’informations, consultez Attributs de caractère.
nLength [entrée]
Nombre de cellules de caractères de la mémoire tampon d’écran dans lesquelles les attributs seront copiés.
dwWriteCoord [entrée]
Un structure COORD qui spécifie les coordonnées de caractères de la première cellule de la mémoire tampon de l’écran de console dans laquelle les attributs seront écrits.
lpNumberOfAttrsWritten [sortie]
Un pointeur vers une variable qui reçoit le nombre d’attributs réellement écrits dans la mémoire tampon de l’écran de la console.
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
Si le nombre d’attributs à écrire dépasse la fin de la ligne spécifiée dans la mémoire tampon de l’écran de console, les attributs sont écrits sur la ligne suivante. Si le nombre d’attributs à écrire dépasse la fin de la mémoire tampon de l’écran de la console, les attributs sont écrits jusqu’à la fin de la mémoire tampon de l’écran de la console.
Les valeurs de caractères aux positions écrites ne sont pas modifiées.
Conseil
Cette API a un équivalent au terminal virtuel dans les séquences de mise en forme du texte et de positionnement de curseur. Déplacez le curseur vers l’emplacement à insérer, appliquez la mise en forme souhaitée et écrivez du texte à remplir. Il n’y a pas d’équivalent à l’application de la couleur à une zone sans également émettre de texte. Cette décision aligne intentionnellement la plateforme Windows avec d’autres systèmes d’exploitation où l’application cliente individuelle est censée mémoriser son propre état dessiné pour une manipulation supplémentaire.
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 |