Fonction SetConsoleCursorInfo
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 la taille et la visibilité du curseur pour la mémoire tampon d’écran de la console spécifiée.
Syntaxe
BOOL WINAPI SetConsoleCursorInfo(
_In_ HANDLE hConsoleOutput,
_In_ const CONSOLE_CURSOR_INFO *lpConsoleCursorInfo
);
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.
lpConsoleCursorInfo [entrée]
Un pointeur vers une structure CONSOLE_CURSOR_INFO qui fournit les nouvelles spécifications du curseur de la mémoire tampon de l’écran de 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
Lorsqu’un curseur de mémoire tampon d’écran est visible, son apparence peut varier, allant du remplissage intégral d’une cellule de caractère à l’affichage d’un trait horizontal au bas de la cellule. Le membre dwSize de la structure CONSOLE_CURSOR_INFO spécifie le pourcentage d’une cellule de caractère remplie par le curseur. Si ce membre est inférieur à 1 ou supérieur à 100, SetConsoleCursorInfo échoue.
Conseil
Cette API a un équivalent au terminal virtuel dans la section visibilité du curseur avec les séquences ^[[?25h et ^[[?25l.
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 |