ホーム › UI.Input.KeyboardAndMouse › GetMouseMovePointsEx

GetMouseMovePointsEx

関数

マウスの移動座標履歴を取得する。

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

シグネチャ

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

INT GetMouseMovePointsEx(
    DWORD cbSize,
    MOUSEMOVEPOINT* lppt,
    MOUSEMOVEPOINT* lpptBuf,
    INT nBufPoints,
    GET_MOUSE_MOVE_POINTS_EX_RESOLUTION resolution
);

パラメーター

名前

型

方向

説明

cbSize

DWORD

MOUSEMOVEPOINT 構造体のサイズ(バイト単位)。

lppt

MOUSEMOVEPOINT*

有効なマウス座標(スクリーン座標)を格納した MOUSEMOVEPOINT 構造体へのポインター。タイムスタンプを含めることもできます。

GetMouseMovePointsEx 関数は、マウス座標の履歴からこの点を検索します。点が見つかった場合、指定された点を含め、その点以前の直近 nBufPoints 件を返します。

アプリケーションがタイムスタンプを指定した場合、GetMouseMovePointsEx 関数はそれを利用して、異なる時刻に記録された同一の 2 点を区別します。

アプリケーションは、WM_MOUSEMOVE メッセージから受け取ったマウス座標を使用してこの関数を呼び出し、それらをスクリーン座標に変換する必要があります。

lpptBuf

MOUSEMOVEPOINT*

out

点を受け取るバッファーへのポインター。サイズは少なくとも cbSize* nBufPoints 以上である必要があります。

nBufPoints

INT

取得する点の数。

resolution

GET_MOUSE_MOVE_POINTS_EX_RESOLUTION

希望する解像度。このパラメーターには次のいずれかの値を指定できます。

値	意味
GMMP_USE_DISPLAY_POINTS 1	表示解像度で点を取得します。
GMMP_USE_HIGH_RESOLUTION_POINTS 2	高解像度の点を取得します。点は x 座標・y 座標とも 0 から 65,535 (0xFFFF) の範囲を取り得ます。これは、ペンタブレットなどの絶対座標ポインティングデバイスが提供する解像度です。

戻り値の型: INT

公式ドキュメント

マウスまたはペンの直近の座標を最大 64 件まで取得します。

戻り値

型: int

関数が成功した場合、戻り値はバッファー内の点の数です。失敗した場合は –1 を返します。拡張エラー情報を取得するには、アプリケーションから GetLastError を呼び出します。

解説(Remarks)

システムは直近 64 件のマウス座標とそのタイムスタンプを保持します。アプリケーションが GetMouseMovePointsEx にマウス座標を渡し、その座標がシステムのマウス座標履歴に存在する場合、この関数はシステムの履歴から指定された数の座標を取得します。タイムスタンプを指定することもでき、これは履歴内の同一の点を区別するために使用されます。

GetMouseMovePointsEx 関数は、最終的に呼び出し元スレッドだけでなく他のスレッドにもディスパッチされた点を返します。

GetMouseMovePointsEx は、次の場合に失敗するか、誤った値を返すことがあります。

MOUSEMOVEPOINT 構造体に負の座標が渡された場合。
GetMouseMovePointsEx が負の値を持つ座標を取得した場合。

これらの状況は、複数のモニターが存在する場合に発生し得ます。これを修正するには、まず GetSystemMetrics を呼び出して次の値を取得します。

次に、GetMouseMovePointsEx から返される各点に対して、次の変換を行います。

int nVirtualWidth = GetSystemMetrics(SM_CXVIRTUALSCREEN) ;
int nVirtualHeight = GetSystemMetrics(SM_CYVIRTUALSCREEN) ;
int nVirtualLeft = GetSystemMetrics(SM_XVIRTUALSCREEN) ;
int nVirtualTop = GetSystemMetrics(SM_YVIRTUALSCREEN) ;
int cpt = 0 ;
int mode = GMMP_USE_DISPLAY_POINTS ;

MOUSEMOVEPOINT mp_in ;
MOUSEMOVEPOINT mp_out[64] ;

ZeroMemory(&mp_in, sizeof(mp_in)) ;
mp_in.x = pt.x & 0x0000FFFF ;//Ensure that this number will pass through.
mp_in.y = pt.y & 0x0000FFFF ;
cpt = GetMouseMovePointsEx(&mp_in, &mp_out, 64, mode) ;

for (int i = 0; i < cpt; i++)
{
   switch(mode)
   {
   case GMMP_USE_DISPLAY_POINTS:
      if (mp_out[i].x > 32767)
         mp_out[i].x -= 65536 ;
      if (mp_out[i].y > 32767)
         mp_out[i].y -= 65536 ;
      break ;
   case GMMP_USE_HIGH_RESOLUTION_POINTS:
      mp_out[i].x = ((mp_out[i].x * (nVirtualWidth - 1)) - (nVirtualLeft * 65536)) / nVirtualWidth ;
      mp_out[i].y = ((mp_out[i].y * (nVirtualHeight - 1)) - (nVirtualTop * 65536)) / nVirtualHeight ;
      break ;
   }
}

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

各言語での呼び出し定義

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

INT GetMouseMovePointsEx(
    DWORD cbSize,
    MOUSEMOVEPOINT* lppt,
    MOUSEMOVEPOINT* lpptBuf,
    INT nBufPoints,
    GET_MOUSE_MOVE_POINTS_EX_RESOLUTION resolution
);

[DllImport("USER32.dll", SetLastError = true, ExactSpelling = true)]
static extern int GetMouseMovePointsEx(
    uint cbSize,   // DWORD
    IntPtr lppt,   // MOUSEMOVEPOINT*
    IntPtr lpptBuf,   // MOUSEMOVEPOINT* out
    int nBufPoints,   // INT
    uint resolution   // GET_MOUSE_MOVE_POINTS_EX_RESOLUTION
);

<DllImport("USER32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetMouseMovePointsEx(
    cbSize As UInteger,   ' DWORD
    lppt As IntPtr,   ' MOUSEMOVEPOINT*
    lpptBuf As IntPtr,   ' MOUSEMOVEPOINT* out
    nBufPoints As Integer,   ' INT
    resolution As UInteger   ' GET_MOUSE_MOVE_POINTS_EX_RESOLUTION
) As Integer
End Function

' cbSize : DWORD
' lppt : MOUSEMOVEPOINT*
' lpptBuf : MOUSEMOVEPOINT* out
' nBufPoints : INT
' resolution : GET_MOUSE_MOVE_POINTS_EX_RESOLUTION
Declare PtrSafe Function GetMouseMovePointsEx Lib "user32" ( _
    ByVal cbSize As Long, _
    ByVal lppt As LongPtr, _
    ByVal lpptBuf As LongPtr, _
    ByVal nBufPoints As Long, _
    ByVal resolution As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetMouseMovePointsEx = ctypes.windll.user32.GetMouseMovePointsEx
GetMouseMovePointsEx.restype = ctypes.c_int
GetMouseMovePointsEx.argtypes = [
    wintypes.DWORD,  # cbSize : DWORD
    ctypes.c_void_p,  # lppt : MOUSEMOVEPOINT*
    ctypes.c_void_p,  # lpptBuf : MOUSEMOVEPOINT* out
    ctypes.c_int,  # nBufPoints : INT
    wintypes.DWORD,  # resolution : GET_MOUSE_MOVE_POINTS_EX_RESOLUTION
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
GetMouseMovePointsEx = Fiddle::Function.new(
  lib['GetMouseMovePointsEx'],
  [
    -Fiddle::TYPE_INT,  # cbSize : DWORD
    Fiddle::TYPE_VOIDP,  # lppt : MOUSEMOVEPOINT*
    Fiddle::TYPE_VOIDP,  # lpptBuf : MOUSEMOVEPOINT* out
    Fiddle::TYPE_INT,  # nBufPoints : INT
    -Fiddle::TYPE_INT,  # resolution : GET_MOUSE_MOVE_POINTS_EX_RESOLUTION
  ],
  Fiddle::TYPE_INT)

#[link(name = "user32")]
extern "system" {
    fn GetMouseMovePointsEx(
        cbSize: u32,  // DWORD
        lppt: *mut MOUSEMOVEPOINT,  // MOUSEMOVEPOINT*
        lpptBuf: *mut MOUSEMOVEPOINT,  // MOUSEMOVEPOINT* out
        nBufPoints: i32,  // INT
        resolution: u32  // GET_MOUSE_MOVE_POINTS_EX_RESOLUTION
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("USER32.dll", SetLastError = true)]
public static extern int GetMouseMovePointsEx(uint cbSize, IntPtr lppt, IntPtr lpptBuf, int nBufPoints, uint resolution);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_GetMouseMovePointsEx' -Namespace Win32 -PassThru
# $api::GetMouseMovePointsEx(cbSize, lppt, lpptBuf, nBufPoints, resolution)

#uselib "USER32.dll"
#func global GetMouseMovePointsEx "GetMouseMovePointsEx" sptr, sptr, sptr, sptr, sptr
; GetMouseMovePointsEx cbSize, varptr(lppt), varptr(lpptBuf), nBufPoints, resolution   ; 戻り値は stat
; cbSize : DWORD -> "sptr"
; lppt : MOUSEMOVEPOINT* -> "sptr"
; lpptBuf : MOUSEMOVEPOINT* out -> "sptr"
; nBufPoints : INT -> "sptr"
; resolution : GET_MOUSE_MOVE_POINTS_EX_RESOLUTION -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "USER32.dll"
#cfunc global GetMouseMovePointsEx "GetMouseMovePointsEx" int, var, var, int, int
; res = GetMouseMovePointsEx(cbSize, lppt, lpptBuf, nBufPoints, resolution)
; cbSize : DWORD -> "int"
; lppt : MOUSEMOVEPOINT* -> "var"
; lpptBuf : MOUSEMOVEPOINT* out -> "var"
; nBufPoints : INT -> "int"
; resolution : GET_MOUSE_MOVE_POINTS_EX_RESOLUTION -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "USER32.dll"
#cfunc global GetMouseMovePointsEx "GetMouseMovePointsEx" int, sptr, sptr, int, int
; res = GetMouseMovePointsEx(cbSize, varptr(lppt), varptr(lpptBuf), nBufPoints, resolution)
; cbSize : DWORD -> "int"
; lppt : MOUSEMOVEPOINT* -> "sptr"
; lpptBuf : MOUSEMOVEPOINT* out -> "sptr"
; nBufPoints : INT -> "int"
; resolution : GET_MOUSE_MOVE_POINTS_EX_RESOLUTION -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。