ホーム › UI.Input.Pointer › GetPointerFrameInfo

GetPointerFrameInfo

関数

同一フレーム内の複数ポインタ情報を取得する。

DLLUSER32.dll呼出規約winapiSetLastErrorあり対応OSwindows8.0

シグネチャ

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

BOOL GetPointerFrameInfo(
    DWORD pointerId,
    DWORD* pointerCount,
    POINTER_INFO* pointerInfo   // optional
);

パラメーター

名前	型	方向	説明
pointerId	DWORD	in	フレーム情報を取得する対象のポインターの識別子。
pointerCount	DWORD*	inout	pointerInfo が指すバッファー内の構造体の数を指定する変数へのポインター。GetPointerFrameInfo が成功した場合、pointerCount はフレーム内のポインターの総数で更新されます。
pointerInfo	POINTER_INFO*	outoptional	ポインター情報を受け取る POINTER_INFO 構造体の配列のアドレス。pointerCount が 0 の場合、このパラメーターは NULL* にできます。

戻り値の型: BOOL

公式ドキュメント

現在のメッセージに関連付けられた、指定されたポインターのフレーム情報全体を取得します。

戻り値

関数が成功した場合、戻り値は 0 以外です。

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

並列モードのデバイスは、ポインター入力をフレーム単位で報告することがあります。つまり、そのデバイスのすべてのポインターの状態と位置を、1 つの入力レポートとしてシステムに報告する場合があります。アプリケーション固有の要件で別の扱いが必要とされない限り、アプリケーションはフレーム全体を 1 つの入力として扱うことが理想的です。

GetPointerFrameInfo は、ポインターメッセージに関連付けられたポインター入力フレーム全体を取得します。ポインターメッセージに関連付けられた単一のポインターの情報を取得するには、GetPointerInfo を使用します。

フレームには、指定されたポインターと同じウィンドウが現在所有しているポインターのみが含まれます。

GetPointerFrameInfo が返す情報は、呼び出し元のスレッドが最後に取得したポインターメッセージに関連付けられています。呼び出し元のスレッドが次のメッセージを取得すると、以前のメッセージに関連付けられた情報は利用できなくなる場合があります。

アプリケーションがポインター入力メッセージを、生成される速度に追いつく形で処理できない場合、一部のメッセージは WM_POINTERUPDATE メッセージに統合されることがあります。最新の WM_POINTERUPDATE メッセージからメッセージ履歴を取得するには、GetPointerFrameInfoHistory を使用します。

フレーム全体の情報を取得した後、アプリケーションは SkipPointerFrameMessages 関数を呼び出して、このフレームに関連付けられた、取得待ちの残りのポインターメッセージをスキップできます。これにより、残りのメッセージを 1 つずつ取得して処理するオーバーヘッドを省けます。ただし、SkipPointerFrameMessages 関数は注意して使用する必要があり、呼び出し元のスレッド上の他のエンティティが、残りのポインターメッセージを取得しながら 1 つずつ処理することを期待していないと確信できる場合にのみ使用してください。

取得される情報は、呼び出し元のスレッドが最後に取得したポインターフレームに関連付けられている点に注意してください。呼び出し元のスレッドが次のメッセージを取得すると、以前のポインターフレームに関連付けられた情報は利用できなくなる場合があります。

ポインターフレームに、指定されたポインター以外のポインターが含まれていない場合、この関数は成功し、指定されたポインターの情報のみを返します。

ポインターフレームに関連付けられた情報がすでに利用できない場合、この関数は失敗し、最終エラーは ERROR_NO_DATA に設定されます。

ポインターメッセージが配信されたウィンドウ (入力が最初に配信されたウィンドウ、またはメッセージが転送されたウィンドウ) を呼び出し元のスレッドが所有していない場合、この関数は失敗し、最終エラーは ERROR_ACCESS_DENIED に設定されます。

クライアント領域と非クライアント領域の両方を持つアプリでは、入力フレームにクライアントデータと非クライアントデータの両方が含まれることがあります。クライアントデータと非クライアントデータを区別するには、対象のウィンドウでヒットテストを実行する必要があります。

入力フレームのデータをフィルター処理する場合は、次の方法を推奨します。

ポインターの接触を伴わない更新 (POINTER_FLAG_INCONTACT を伴わない POINTER_FLAG_UPDATE) ごとに、ヒットテストを行って入力がクライアントか非クライアントかを判定します。
新しい接触 (POINTER_FLAG_DOWN) ごとに、ヒットテストを行って入力がクライアントか非クライアントかを判定し、この情報を追跡します。
ポインターの接触を伴う更新 (POINTER_FLAG_INCONTACT を伴う POINTER_FLAG_UPDATE) ごとに、追跡情報を使用して入力がクライアントか非クライアントかを判定します。
POINTER_FLAG_UP ごとに、追跡情報を使用して入力がクライアントか非クライアントかを判定し、その後このポインターを追跡データから削除します。

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

各言語での呼び出し定義

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

BOOL GetPointerFrameInfo(
    DWORD pointerId,
    DWORD* pointerCount,
    POINTER_INFO* pointerInfo   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool GetPointerFrameInfo(
    uint pointerId,   // DWORD
    ref uint pointerCount,   // DWORD* in/out
    IntPtr pointerInfo   // POINTER_INFO* optional, out
);

<DllImport("USER32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetPointerFrameInfo(
    pointerId As UInteger,   ' DWORD
    ByRef pointerCount As UInteger,   ' DWORD* in/out
    pointerInfo As IntPtr   ' POINTER_INFO* optional, out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' pointerId : DWORD
' pointerCount : DWORD* in/out
' pointerInfo : POINTER_INFO* optional, out
Declare PtrSafe Function GetPointerFrameInfo Lib "user32" ( _
    ByVal pointerId As Long, _
    ByRef pointerCount As Long, _
    ByVal pointerInfo As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetPointerFrameInfo = ctypes.windll.user32.GetPointerFrameInfo
GetPointerFrameInfo.restype = wintypes.BOOL
GetPointerFrameInfo.argtypes = [
    wintypes.DWORD,  # pointerId : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pointerCount : DWORD* in/out
    ctypes.c_void_p,  # pointerInfo : POINTER_INFO* optional, out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
GetPointerFrameInfo = Fiddle::Function.new(
  lib['GetPointerFrameInfo'],
  [
    -Fiddle::TYPE_INT,  # pointerId : DWORD
    Fiddle::TYPE_VOIDP,  # pointerCount : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # pointerInfo : POINTER_INFO* optional, out
  ],
  Fiddle::TYPE_INT)

#[link(name = "user32")]
extern "system" {
    fn GetPointerFrameInfo(
        pointerId: u32,  // DWORD
        pointerCount: *mut u32,  // DWORD* in/out
        pointerInfo: *mut POINTER_INFO  // POINTER_INFO* optional, 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 GetPointerFrameInfo(uint pointerId, ref uint pointerCount, IntPtr pointerInfo);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_GetPointerFrameInfo' -Namespace Win32 -PassThru
# $api::GetPointerFrameInfo(pointerId, pointerCount, pointerInfo)

#uselib "USER32.dll"
#func global GetPointerFrameInfo "GetPointerFrameInfo" sptr, sptr, sptr
; GetPointerFrameInfo pointerId, varptr(pointerCount), varptr(pointerInfo)   ; 戻り値は stat
; pointerId : DWORD -> "sptr"
; pointerCount : DWORD* in/out -> "sptr"
; pointerInfo : POINTER_INFO* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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