ホーム › UI.Input.Pointer › GetPointerFramePenInfoHistory

GetPointerFramePenInfoHistory

関数

同一フレームの複数ペン入力情報の履歴を取得する。

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

シグネチャ

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

BOOL GetPointerFramePenInfoHistory(
    DWORD pointerId,
    DWORD* entriesCount,
    DWORD* pointerCount,
    POINTER_PEN_INFO* penInfo   // optional
);

パラメーター

名前	型	方向	説明
pointerId	DWORD	in	フレーム情報を取得する対象のポインターの識別子。
entriesCount	DWORD*	inout	penInfo が指す 2 次元配列の行数を指定する変数へのポインター。GetPointerFramePenInfoHistory が成功した場合、entriesCount は履歴内で利用可能なフレームの総数に更新されます。
pointerCount	DWORD*	inout	penInfo が指す 2 次元配列の列数を指定する変数へのポインター。GetPointerFramePenInfoHistory が成功した場合、pointerCount は各フレーム内のポインターの総数に更新されます。
penInfo	POINTER_PEN_INFO*	outoptional	ポインター情報を受け取る POINTER_PEN_INFO 構造体の 2 次元配列のアドレス。entriesCount と pointerCount がどちらも 0 の場合、このパラメーターは NULL にできます。この配列は POINTER_PEN_INFO[entriesCount][pointerCount] として解釈されます。

戻り値の型: BOOL

公式ドキュメント

現在のメッセージに関連付けられた、指定されたポインター (PT_PEN 型) に関するペンベースの情報のフレーム全体 (結合された入力フレームを含む) を取得します。

戻り値

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

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

解説(Remarks)

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

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

アプリケーションがポインター入力メッセージを生成される速度で処理できない場合、一部のメッセージは WM_POINTERUPDATE メッセージに結合されることがあります。最新の WM_POINTERUPDATE メッセージからメッセージ履歴 (結合された入力フレームを含む) を取得するには、GetPointerFramePenInfoHistory を使用します。

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

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

取得される情報は、履歴エントリごとに 1 行、フレーム内のポインターごとに 1 列を持つ 2 次元配列を表します。

取得される情報は新しいものから順 (逆時系列) に並び、最新のエントリは返される配列の先頭行に格納されます。最新のエントリは、GetPointerFramePenInfo 関数が返すものと同じです。

指定されたバッファーの行数が、利用可能なすべての履歴エントリを保持するのに不十分な場合、この関数は成功し、バッファーには最新のエントリが格納され、*entriesCount には利用可能なエントリの総数が格納されます。

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

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

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

指定されたポインターが PT_PEN 型でない場合、この関数は失敗し、最終エラーは ERROR_DATATYPE_MISMATCH に設定されます。

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

入力フレームからデータをフィルター処理する場合は、次の方法をお勧めします。

ポインターの接触を含まない更新 (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 GetPointerFramePenInfoHistory(
    DWORD pointerId,
    DWORD* entriesCount,
    DWORD* pointerCount,
    POINTER_PEN_INFO* penInfo   // optional
);

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

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

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

import ctypes
from ctypes import wintypes

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

require 'fiddle'
require 'fiddle/import'

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

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

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

出力引数:

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