ホーム › UI.WindowsAndMessaging › GetCursorPos

GetCursorPos

関数

カーソルの現在の画面座標を取得する。

DLLUSER32.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// USER32.dll
#include <windows.h>

BOOL GetCursorPos(
    POINT* lpPoint
);

パラメーター

名前	型	方向	説明
lpPoint	POINT*	out	カーソルのスクリーン座標を受け取る POINT 構造体へのポインターです。

戻り値の型: BOOL

公式ドキュメント

マウスカーソルの位置を、スクリーン座標で取得します。

戻り値

型: BOOL

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

解説(Remarks)

カーソル位置は常にスクリーン座標で指定され、カーソルを含むウィンドウのマッピングモードの影響を受けません。

呼び出し元のプロセスは、ウィンドウステーションに対する WINSTA_READATTRIBUTES アクセス権を持っている必要があります。

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

例

例については、キーボードを使ったカーソルの移動を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// USER32.dll
#include <windows.h>

BOOL GetCursorPos(
    POINT* lpPoint
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool GetCursorPos(
    IntPtr lpPoint   // POINT* out
);

<DllImport("USER32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetCursorPos(
    lpPoint As IntPtr   ' POINT* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' lpPoint : POINT* out
Declare PtrSafe Function GetCursorPos Lib "user32" ( _
    ByVal lpPoint As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetCursorPos = ctypes.windll.user32.GetCursorPos
GetCursorPos.restype = wintypes.BOOL
GetCursorPos.argtypes = [
    ctypes.c_void_p,  # lpPoint : POINT* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
GetCursorPos = Fiddle::Function.new(
  lib['GetCursorPos'],
  [
    Fiddle::TYPE_VOIDP,  # lpPoint : POINT* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "user32")]
extern "system" {
    fn GetCursorPos(
        lpPoint: *mut POINT  // POINT* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", SetLastError = true)]
public static extern bool GetCursorPos(IntPtr lpPoint);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_GetCursorPos' -Namespace Win32 -PassThru
# $api::GetCursorPos(lpPoint)

#uselib "USER32.dll"
#func global GetCursorPos "GetCursorPos" sptr
; GetCursorPos varptr(lpPoint)   ; 戻り値は stat
; lpPoint : POINT* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "USER32.dll"
#cfunc global GetCursorPos "GetCursorPos" var
; res = GetCursorPos(lpPoint)
; lpPoint : POINT* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "USER32.dll"
#cfunc global GetCursorPos "GetCursorPos" sptr
; res = GetCursorPos(varptr(lpPoint))
; lpPoint : POINT* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。