Fonction HideCaret (winuser.h)

Article
08/27/2023

Supprime le caret de l’écran. Le fait de masquer un caret ne détruit pas sa forme actuelle et n’invalide pas le point d’insertion.

Syntaxe

BOOL HideCaret(
  [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, HideCaret recherche dans la tâche en cours 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

HideCaret masque le caret uniquement si la fenêtre spécifiée possède le caret. Si la fenêtre spécifiée ne possède pas le caret, HideCaret 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 s’affiche.

Pour obtenir un exemple, consultez Masquer un caret.

Configuration requise


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)