GetRawInputData 函式 (winuser.h)

發行項
03/04/2024

從指定的裝置擷取原始輸入。

語法

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 的值。如果 pData 為 NULL，則緩衝區的必要大小會以 *mbSize 傳回。

[in, out] pcbSize

類型： PUINT

pData 中數據的大小，以位元組為單位。

[in] cbSizeHeader

類型： UINT

RAWINPUTHEADER 結構的大小，以位元組為單位。

傳回值

類型： UINT

如果 pData 為 NULL 且函式成功，則傳回值為 0。如果 pData 不是 NULL 且函式成功，則傳回值是複製到 pData 的位元組數目。

如果發生錯誤，傳回值會 (UINT) -1。

備註

GetRawInputData 一次取得一個 RAWINPUT 結構的原始輸入。相反地， GetRawInputBuffer 會取得 RAWINPUT 結構的陣列。

規格需求

需求	值
最低支援的用戶端	Windows XP [僅限傳統型應用程式]
最低支援的伺服器	Windows Server 2003 [僅限傳統型應用程式]
目標平台	Windows
標頭	winuser.h (包括 Windows.h)
程式庫	User32.lib
Dll	User32.dll
API 集合	ext-ms-win-ntuser-rawinput-l1-1-0 (於 Windows 10 10.0.14393 版中引進)