Fonction ShowCaret (winuser.h)

Article
08/28/2023

Rend le caresse visible sur l’écran à la position actuelle du caret. Lorsque le caret devient visible, il commence à clignoter automatiquement.

Syntaxe

BOOL ShowCaret(
  [in, optional] HWND hWnd
);

Paramètres

[in, optional] hWnd

Type : HWND

Poignée de la fenêtre qui possède le caret. Si ce paramètre a la valeur NULL, ShowCaret recherche dans la tâche actuelle la fenêtre qui possède le 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

ShowCaret affiche le caret uniquement si la fenêtre spécifiée possède le caret, si le caret a une forme et que le caret n’a pas été masqué deux ou plusieurs fois dans une ligne. Si une ou plusieurs de ces conditions ne sont pas remplies, ShowCaret ne fait rien et retourne FALSE.

Le masquage est cumulatif. Si votre application appelle HideCaret cinq fois de suite, elle doit également appeler ShowCaret cinq fois avant que le caret ne réapparaisse.

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.

Exemples

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

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]
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)