CreateCaret, fonction (winuser.h)

Article
05/09/2024

Crée une forme pour l’insertion système et affecte la propriété de l’insertion à la fenêtre spécifiée. La forme d’insertion peut être une ligne, un bloc ou une bitmap.

Syntaxe

BOOL CreateCaret(
  [in]           HWND    hWnd,
  [in, optional] HBITMAP hBitmap,
  [in]           int     nWidth,
  [in]           int     nHeight
);

Paramètres

[in] hWnd

Type : HWND

Poignée de la fenêtre qui possède l’entête.

[in, optional] hBitmap

Type : HBITMAP

Handle de la bitmap qui définit la forme d’insertion. Si ce paramètre a la valeur NULL, l’insertion est solide. Si ce paramètre a la valeur (HBITMAP) 1, l’insertion est grise. Si ce paramètre est un handle bitmap, l’insertion est la bitmap spécifiée. Le handle bitmap doit avoir été créé par la fonction CreateBitmap, CreateDIBitmap ou LoadBitmap . L’insertion est dessinée à l’écran via l’opération XOR.

Si hBitmap est un handle bitmap, CreateCaret ignore les paramètres nWidth et nHeight ; la bitmap définit sa propre largeur et hauteur. L’application ne doit pas supprimer le hBitmap tant que l’insertion n’a pas été détruite ou remplacée par un autre signe d’insertion.

[in] nWidth

Type : int

Largeur de l’insertion, en unités logiques. Si ce paramètre est égal à zéro, la largeur est définie sur la largeur de bordure de fenêtre définie par le système. Si hBitmap est un handle bitmap, CreateCaret ignore ce paramètre.

[in] nHeight

Type : int

Hauteur de l’insertion, en unités logiques. Si ce paramètre est égal à zéro, la hauteur est définie sur la hauteur de bordure de fenêtre définie par le système. Si hBitmap est un handle bitmap, CreateCaret ignore ce paramètre.

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

Les paramètres nWidth et nHeight spécifient la largeur et la hauteur du caret, en unités logiques ; La largeur et la hauteur exactes, en pixels, dépendent du mode de mappage de la fenêtre.

CreateCaret détruit automatiquement la forme d’insertion précédente, le cas échéant, quelle que soit la fenêtre qui possède l’insertion. L’insertion est masquée jusqu’à ce que l’application appelle la fonction ShowCaret pour rendre l’insertion visible.

Le système fournit un point d’insertion par file d’attente. Une fenêtre ne doit créer un signe d’insertion que lorsqu’elle a le focus clavier ou qu’elle est active. La fenêtre doit détruire l’insertion avant de perdre le focus du clavier ou de devenir inactive.

Virtualisation PPP

Cette API ne participe pas à la virtualisation PPP. Les paramètres width et height sont interprétés comme des tailles logiques en termes de fenêtre en question. Le thread appelant n’est pas pris en compte.

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)