GetPointerInfo 関数 (winuser.h)
現在のメッセージに関連付けられている指定されたポインターの情報を取得します。
構文
BOOL GetPointerInfo(
[in] UINT32 pointerId,
[out] POINTER_INFO *pointerInfo
);
パラメーター
[in] pointerId
ポインター識別子。
[out] pointerInfo
ポインター情報を受け取る POINTER_INFO 構造体のアドレス。
戻り値
関数が成功した場合、戻り値は 0 以外です。
関数が失敗した場合は、0 を返します。 詳細なエラー情報を得るには、GetLastError を呼び出します。
解説
GetPointerInfo は、ポインター メッセージに関連付けられた 1 つのポインターの情報を取得します。
一連のポインターのメッセージに関連付けられているフレーム情報を取得するには、 GetPointerFrameInfo を使用します。
GetPointerInfo によって返される情報は、呼び出し元のスレッドによって取得された最新のポインター メッセージに関連付けられます。 呼び出し元のスレッドによって次のメッセージが取得されると、前のメッセージに関連付けられている情報が使用できなくなる可能性があります。
アプリケーションがポインター入力メッセージを生成ほど速く処理しない場合は、一部のメッセージが WM_POINTERUPDATE メッセージに結合される可能性があります。 GetPointerInfoHistory を使用して、最新のWM_POINTERUPDATE メッセージからメッセージ履歴を取得します。
メッセージに関連付けられている情報が使用できなくなった場合、この関数は失敗し、最後のエラーが ERROR_NO_DATA に設定されます。
呼び出し元のスレッドがポインター メッセージが配信されたウィンドウを所有していない場合、この関数は失敗し、最後のエラーが ERROR_ACCESS_DENIED に設定されます。 これは、入力が最初に配信されたウィンドウであるか、メッセージが転送されたウィンドウである可能性があることに注意してください。
要件
要件 | 値 |
---|---|
サポートされている最小のクライアント | Windows 8 [デスクトップ アプリのみ] |
サポートされている最小のサーバー | Windows Server 2012 [デスクトップ アプリのみ] |
対象プラットフォーム | Windows |
ヘッダー | winuser.h (Windows.h を含む) |
Library | User32.lib |
[DLL] | User32.dll |
API セット | ext-ms-win-rtcore-ntuser-wmpointer-l1-1-0 (Windows 10 バージョン 10.0.14393 で導入) |