GetRawInputData 関数 (winuser.h)

2025-05-21

指定したデバイスから生の入力を取得します。

構文

UINT GetRawInputData(
  [in]            HRAWINPUT hRawInput,
  [in]            UINT      uiCommand,
  [out, optional] LPVOID    pData,
  [in, out]       PUINT     pcbSize,
  [in]            UINT      cbSizeHeader
);

パラメーター

[in] hRawInput

型: HRAWINPUT

RAWINPUT 構造体へのハンドル。これは、WM_INPUTの lParam に由来します。

[in] uiCommand

型: UINT

コマンドフラグ。このパラメーターには、次のいずれかの値を指定できます。

価値	意味
RID_HEADER 0x10000005	RAWINPUT 構造体からヘッダー情報を取得します。
RID_INPUT 0x10000003	RAWINPUT 構造体から生データを取得します。

[out, optional] pData

型: LPVOID

RAWINPUT 構造体から取得されるデータへのポインター。これは uiCommand の値によって異なります。ポインターは DWORD (32 ビット) 境界に配置する必要があります。

pData が NULL の場合、バッファーの必要なサイズは *pcbSize で返されます。

[in, out] pcbSize

型: PUINT

pData 内のデータのサイズ (バイト単位)。

[in] cbSizeHeader

型: UINT

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

戻り値

型: UINT

pData が NULL で、関数が成功した場合、戻り値は 0 になります。 pData が NULL ではなく、関数が成功した場合、戻り値は pData にコピーされたバイト数です。

エラーが発生した場合、戻り値は (UINT)-1 です。

注釈

GetRawInputData は、生入力を一度に 1 つの RAWINPUT 構造体で取得します。これに対し、 GetRawInputBuffer は RAWINPUT 構造体の配列を取得します。

要求事項

要件	価値
サポートされる最小クライアント	Windows XP (デスクトップアプリのみ)
サポートされている最小のサーバー	Windows Server 2003 (デスクトップアプリのみ)
ターゲットプラットフォームの	ウィンドウズ
ヘッダー	winuser.h (Windows.h を含む)
図書館	User32.lib
DLL	User32.dll
API セットの	ext-ms-win-ntuser-rawinput-l1-1-0 (Windows 10 バージョン 10.0.14393 で導入)