CaretGetPos

キャレット（テキスト挿入点）の現在位置を取得します。

CaretFound := CaretGetPos(&OutputVarX, &OutputVarY)

パラメータ

&OutputVarX, &OutputVarY

型：VarRef

省略したときは、対応する値は保存されません。そうでないときは、X座標とY座標を格納する出力変数への参照を指定します。座標は、CoordModeまたはA_CoordModeCaretを使用して上書きされない限り、アクティブウィンドウのクライアント領域からの相対座標となります。

戻り値

型：整数（ブーリアン）

アクティブなウィンドウがない場合、またはキャレット位置が決定できない場合、この関数は0（偽）を返し、出力変数は空白にされます。この関数は、システムがキャレット位置を返した場合、1（真）を返しますが、これは必ずしもキャレットが見えていることを意味するわけではありません。

備考

対応する情報が不要な場合は、出力変数のいずれかを省略することができる。

一部のウィンドウ（MS Wordの特定のバージョンなど）では、実際の位置に関係なく、同じキャレット位置を報告することに注意してください。

関連

CoordMode、A_CoordModeCaret

例

SetTimer WatchCaret, 100
WatchCaret() {
    if CaretGetPos(&x, &y)
        ToolTip "X" x " Y" y, x, y - 20
    else
        ToolTip "No caret"
}