SetCursorPos 関数 (winuser.h)

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

指定した画面座標にカーソルを移動します。新しい座標が、最新の ClipCursor 関数呼び出しによって設定された画面の四角形内にない場合、カーソルが四角形内に留まるように座標が自動的に調整されます。

構文

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

パラメーター

[in] X

型: int

カーソルの新しい x 座標 (画面座標)。

[in] Y

型: int

カーソルの新しい y 座標 (画面座標)。

戻り値

種類: BOOL

成功した場合は 0 以外、それ以外の場合は 0 を返します。詳細なエラー情報を得るには、GetLastError を呼び出します。

解説

カーソルは共有リソースです。ウィンドウは、カーソルがウィンドウのクライアント領域にある場合にのみカーソルを移動する必要があります。

呼び出しプロセスには、ウィンドウステーションへの WINSTA_WRITEATTRIBUTES アクセス権が必要です。

SetCursorPos を呼び出すときは、入力デスクトップが現在のデスクトップである必要があります。 OpenInputDesktop を呼び出して、現在のデスクトップが入力デスクトップであるかどうかを判断します。そうでない場合は、 OpenInputDesktop によって返された HDESK を使用して SetThreadDesktop を呼び出して、そのデスクトップに切り替えます。

例

例については、「キーボードを使用してカーソルを移動する」を参照してください。

要件

要件	値
サポートされている最小のクライアント	Windows 2000 Professional [デスクトップアプリのみ]
サポートされている最小のサーバー	Windows 2000 Server [デスクトップアプリのみ]
対象プラットフォーム	Windows
ヘッダー	winuser.h (Windows.h を含む)
Library	User32.lib
[DLL]	User32.dll
API セット	ext-ms-win-ntuser-window-l1-1-2 (Windows 10 バージョン 10.0.10240 で導入)