Fonction SetCaretPos (winuser.h)

Article
03/04/2024

Déplace le caret vers les coordonnées spécifiées. Si la fenêtre qui possède le caret a été créée avec le style de classe CS_OWNDC , les coordonnées spécifiées sont soumises au mode de mappage du contexte d’appareil associé à cette fenêtre.

Syntaxe

BOOL SetCaretPos(
  [in] int X,
  [in] int Y
);

Paramètres

[in] X

Type : int

Nouvelle coordonnée x du caret.

[in] Y

Type : int

Nouvelle coordonnée y du caret.

Valeur retournée

Type : BOOL

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.

Remarques

SetCaretPos déplace le caret si le caret est masqué.

Le système fournit un caret par file d’attente. Une fenêtre doit créer un caret uniquement lorsqu’elle a le focus clavier ou qu’elle est active. La fenêtre doit détruire la caresse avant de perdre le focus du clavier ou de devenir inactive. Une fenêtre ne peut définir la position du caret que si elle est propriétaire du caret.

Virtualisation DPI

Cette API ne participe pas à la virtualisation DPI. La position fournie est interprétée comme des coordonnées logiques en termes de fenêtre associée au caret. Le thread appelant n’est pas pris en compte.

Exemples

Pour obtenir un exemple, consultez Création et affichage d’un caret.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows 2000 Professionnel [applications de bureau uniquement]
Serveur minimal pris en charge	Windows 2000 Server [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	winuser.h (inclure Windows.h)
Bibliothèque	User32.lib
DLL	User32.dll
Ensemble d’API	ext-ms-win-ntuser-caret-l1-1-0 (introduit dans Windows 8)