<Return[D]><Top>

DestroyCaret

Declare Function Api_DestroyCaret& Lib "user32" Alias "DestroyCaret" ()

Declare Function DestroyCaret Lib "user32" Alias "DestroyCaret" () As Long

キャレットの現在の形を破棄し、キャレットをウィンドウから解放し、画面から消去する。

キャレットの形がビットマップに基づいているときは、キャレットを破棄するだけで、元のビットマップは解放しない。

パラメータ
    パラメータはなし。

戻り値
    関数が成功すると、0 以外の値が返る。
    関数が失敗すると、0 が返る。拡張エラー情報を取得するには、GetLastError 関数を使う。

解説
    この関数は、現在のタスクのウィンドウがキャレットを所有するときにだけ、キャレットを破棄する。

    現在のタスク内にないウィンドウがキャレットを所有している場合は、何もせずに 0(FALSE)を返す。