SetCaretPos 関数 (winuser.h)

[アーティクル]
03/04/2024

キャレットを指定した座標に移動します。キャレットを所有するウィンドウが CS_OWNDC クラススタイルで作成された場合、指定した座標は、そのウィンドウに関連付けられているデバイスコンテキストのマッピングモードの対象となります。

構文

BOOL SetCaretPos(
  [in] int X,
  [in] int Y
);

パラメーター

[in] X

型: int

キャレットの新しい x 座標。

[in] Y

型: int

キャレットの新しい y 座標。

戻り値

種類: BOOL

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

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

解説

SetCaretPos は、キャレットが非表示であるかどうかをキャレットに移動します。

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

DPI 仮想化

この API は、DPI 仮想化には参加しません。指定された位置は、キャレットに関連付けられたウィンドウの観点から論理座標として解釈されます。呼び出し元のスレッドは考慮されません。

例

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

要件

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