GetPointerPenInfo 関数 (winuser.h)

現在のメッセージに関連付けられている指定したポインター ( 型PT_PEN) のペンベースの情報を取得します。

構文

BOOL GetPointerPenInfo(
  [in]  UINT32           pointerId,
  [out] POINTER_PEN_INFO *penInfo
);

パラメーター

[in] pointerId

情報を取得するポインターの識別子。

[out] penInfo

ペン固有のポインター情報を受け取る POINTER_PEN_INFO 構造体のアドレス。

戻り値

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

関数が失敗した場合は、0 を返します。 詳細なエラー情報を得るには、GetLastError を呼び出します。

解説

GetPointerPenInfo は、ポインター メッセージに関連付けられた 1 つのポインター ( 型PT_PEN) の情報を取得します。

GetPointerFramePenInfo を使用して、ポインターのセットのメッセージに関連付けられているフレーム情報を取得します。

GetPointerInfo によって返される情報は、呼び出し元のスレッドによって取得された最新のポインター メッセージに関連付けられます。 呼び出し元のスレッドによって次のメッセージが取得されると、前のメッセージに関連付けられた情報が使用できなくなる可能性があります。

アプリケーションがポインター入力メッセージを生成ほど速く処理しない場合は、一部のメッセージが WM_POINTERUPDATE メッセージに結合される可能性があります。 GetPointerPenInfoHistory を使用して、最新のWM_POINTERUPDATE メッセージからメッセージ履歴を取得します。

メッセージに関連付けられている情報が使用できなくなった場合、この関数は最後のエラーが ERROR_NO_DATA に設定されて失敗します。

呼び出し元のスレッドがポインター メッセージが配信されたウィンドウを所有していない場合、この関数は失敗し、最後のエラーが ERROR_ACCESS_DENIED に設定されます。 これは、入力が最初に配信されたウィンドウ、またはメッセージが転送されたウィンドウである可能性があることに注意してください。

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

要件

サポートされている最小のクライアント	Windows 8 [デスクトップ アプリのみ]
サポートされている最小のサーバー	Windows Server 2012 [デスクトップ アプリのみ]
対象プラットフォーム	Windows
ヘッダー	winuser.h (Windows.h を含む)
Library	User32.lib
[DLL]	User32.dll

関連項目

関数

GetPointerFramePenInfo

GetPointerFramePenInfoHistory

GetPointerPenInfoHistory