HideCaret 関数 (winuser.h)

キャレットを画面から削除します。キャレットを非表示にしても、現在の図形が破棄されたり、挿入ポイントが無効化されたりすることはありません。

構文

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

[in, optional] hWnd

型: HWND

キャレットを所有するウィンドウへのハンドル。このパラメーターが NULL の場合、 HideCaret はキャレットを所有するウィンドウを現在のタスクで検索します。

種類: BOOL

関数が成功すると、戻り値は 0 以外になります。

関数が失敗した場合は、0 を返します。詳細なエラー情報を得るには、GetLastError を呼び出します。

HideCaret は、指定されたウィンドウがキャレットを所有している場合にのみ、キャレットを非表示にします。指定したウィンドウがキャレットを所有していない場合、 HideCaret は何も実行せず、 FALSE を返します。

非表示は累積的です。アプリケーションが HideCaret を 5 回連続して呼び出す場合は、キャレットが表示される前に ShowCaret も 5 回呼び出す必要があります。

例については、「キャレットを非表示にする」を参照してください。


サポートされている最小のクライアント	Windows 2000 Professional [デスクトップアプリのみ]
サポートされている最小のサーバー	Windows 2000 Server [デスクトップアプリのみ]
対象プラットフォーム	Windows
ヘッダー	winuser.h (Windows.h を含む)
Library	User32.lib
[DLL]	User32.dll
API セット	ext-ms-win-ntuser-caret-l1-1-0 (Windows 8 で導入)