ShowCaret 関数 (winuser.h)

  • [アーティクル]

キャレットをキャレットの現在位置で画面に表示します。 キャレットが表示されると、自動的にフラッシュが開始されます。

構文

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

パラメーター

[in, optional] hWnd

型: HWND

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

戻り値

種類: BOOL

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

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

解説

ShowCaret は、指定されたウィンドウがキャレットを所有し、キャレットに図形があり、キャレットが 2 回以上連続して非表示になっていない場合にのみ、キャレットを表示します。 これらの条件の 1 つ以上が満たされない場合、 ShowCaret は何も実行せず、 FALSE を返します。

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

システムは、キューごとに 1 つのキャレットを提供します。 ウィンドウにキャレットが作成されるのは、キーボード フォーカスがある場合、またはアクティブな場合のみです。 ウィンドウは、キーボードフォーカスを失うか非アクティブになる前にキャレットを破棄する必要があります。

例

例については、「 キャレットの作成と表示」を参照してください。

要件

   
サポートされている最小のクライアント 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 で導入)

関連項目

キャレット

概念

CreateCaret

DestroyCaret

GetCaretPos

HideCaret

リファレンス

SetCaretPos