Fonction WriteConsoleOutputCharacter
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 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 WriteConsoleOutputCharacter(
_In_ HANDLE hConsoleOutput,
_In_ LPCTSTR lpCharacter,
_In_ DWORD nLength,
_In_ COORD dwWriteCoord,
_Out_ LPDWORD lpNumberOfCharsWritten
);
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.
lpCharacter [entrée]
Les caractères à écrire dans la mémoire tampon de l’écran de la console.
nLength [entrée]
Nombre de caractères à écrire.
dwWriteCoord [entrée]
Une 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 caractères seront écrits.
lpNumberOfCharsWritten [sortie]
Pointeur vers une variable qui reçoit le nombre de caractères réellement écrits.
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 de caractères à écrire dépasse la fin de la ligne spécifiée dans la mémoire tampon de l’écran de console, les caractères sont écrits sur la ligne suivante. Si le nombre de caractères à écrire dépasse la fin de la mémoire tampon de l’écran de la console, les caractères sont écrits jusqu’à la fin de la mémoire tampon de l’écran de la console.
Les valeurs d’attribut aux positions écrites à ne sont pas modifiées.
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 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’existe aucun équivalent pour émettre du texte dans une zone sans appliquer également la mise en forme de couleur active. 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 |
| Noms Unicode et ANSI | WriteConsoleOutputCharacterW (Unicode) et WriteConsoleOutputCharacterA (ANSI) |