HidP_InitializeReportForID函式 (hidpi.h)

  • 發行項

HidP_InitializeReportForID例程會初始化 HID 報告。

語法

NTSTATUS HidP_InitializeReportForID(
  [in]  HIDP_REPORT_TYPE     ReportType,
  [in]  UCHAR                ReportID,
  [in]  PHIDP_PREPARSED_DATA PreparsedData,
  [out] PCHAR                Report,
  [in]  ULONG                ReportLength
);

參數

[in] ReportType

指定 HIDP_REPORT_TYPE 列舉值，指出位於 報表的 HID 報表類型。

[in] ReportID

指定報表標識碼。

[in] PreparsedData

與位於報表之 HID 報表相關聯之最上層集合之預先剖析數據的指標。

[out] Report

呼叫端配置的緩衝區指標，其中包含 HidP_InitializeReportForID 初始化的 HID 報表。

[in] ReportLength

指定位於 [報表] 之 HID 報表的大小，以位元組為單位。 ReportLength 必須等於集合所指定報表類型的報表長度，如集合HIDP_CAPS結構的 XxxReportByteLength 成員所指定。

傳回值

HidP_InitializeReportForID 會傳回下列其中一個狀態值：

傳回碼 Description
HIDP_STATUS_SUCCESS
 已成功初始化報表。
HIDP_STATUS_INVALID_PREPARSED_DATA
 預先剖析的數據無效。
HIDP_STATUS_INVALID_REPORT_LENGTH
 報表的指定長度不等於指定之報表類型的集合報表長度。
HIDP_STATUS_INVALID_REPORT_TYPE
 報表類型無效。
HIDP_STATUS_REPORT_DOES_NOT_EXIST
 指定的報表標識碼無效。

備註

初始化 HID 報表會將所有控件數據設定為零或控件的 Null 值，如 USB HID 標準所定義。 (傳送或接收 null 值表示控件的目前值不應修改。)

HidP_InitializeReportForID 會執行下列動作：

  • 將所有按鈕和值不含 Null 值的位欄位元位元設定為零。
  • 將所有具有 Null 值的控件位欄位元元設定為其對應的 Null 值。
如需詳細資訊，請參閱 HID 集合。

規格需求

需求 值
最低支援的用戶端 適用於 Windows 2000 和更新版本的 Windows。
目標平台 Universal
標頭 hidpi.h (包含 Hidpi.h)
程式庫 Hidparse.lib
IRQL <= DISPATCH_LEVEL

另請參閱

HIDP_CAPS

HIDP_REPORT_TYPE

HidP_GetCaps

_HIDP_PREPARSED_DATA