DestroyCaret 関数 (winuser.h)

  • [アーティクル]

キャレットの現在の図形を破棄し、ウィンドウからキャレットを解放し、キャレットを画面から削除します。

構文

BOOL DestroyCaret();

戻り値

種類: BOOL

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

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

解説

DestroyCaret は、現在のタスクのウィンドウがキャレットを所有している場合にのみ、キャレットを破棄します。 現在のタスクにないウィンドウがキャレットを所有している場合、 DestroyCaret は何も実行せず 、FALSE を返します。

システムは、キューごとに 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

HideCaret

リファレンス

ShowCaret