Fonction SetConsoleCursorPosition

Article
12/15/2023

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 position du curseur dans la mémoire tampon d’écran de la console spécifiée.

Syntaxe

BOOL WINAPI SetConsoleCursorPosition(
  _In_ HANDLE hConsoleOutput,
  _In_ COORD  dwCursorPosition
);

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.

dwCursorPosition [entrée]
Une structure COORD qui spécifie la nouvelle position du curseur, en caractères. Les coordonnées sont la colonne et la ligne d’une cellule de caractère de mémoire tampon d’écran. Les coordonnées doivent se trouver dans les limites de la mémoire tampon d’é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

La position du curseur détermine l’emplacement où les caractères écrits par la fonction WriteFile ou WriteConsole, ou en écho par la fonction ReadFile ou ReadConsole, sont affichés. Pour déterminer la position actuelle du curseur, utilisez la fonction GetConsoleScreenBufferInfo.

Si la nouvelle position du curseur ne se trouve pas dans les limites de la fenêtre de la mémoire tampon de l’écran de console, l’origine de la fenêtre change pour rendre le curseur visible.

Conseil

Cette API a un équivalent au terminal virtuel dans les sections positionnement de curseur simple et positionnement de curseur. L’utilisation des séquences de contrôle nouvelle ligne, retour chariot, retour arrière et tabulation peut également vous aider à positionner le curseur.

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