通过

HidP_GetData函数 （hidpi.h）

  • 项目

对于指定的报表，HidP_GetData 例程返回一组 HIDP_DATA 结构，用于标识当前设置为 ON（1）的所有 HID 控件按钮 数据索引以及与所有 HID 控件值关联的数据索引和数据。

语法

NTSTATUS HidP_GetData(
  [in]      HIDP_REPORT_TYPE     ReportType,
  [out]     PHIDP_DATA           DataList,
  [in, out] PULONG               DataLength,
  [in]      PHIDP_PREPARSED_DATA PreparsedData,
  [in]      PCHAR                Report,
  [in]      ULONG                ReportLength
);

参数

[in] ReportType

指定一个 HIDP_REPORT_TYPE 枚举器值，该值指示位于 报表的 HID 报表的类型。

[out] DataList

指定调用方分配的HIDP_DATA结构的数组，该结构例程用于返回有关当前设置为 ON 的所有按钮以及与值关联的数据的信息。

[in, out] DataLength

指定在输入时，调用方分配 DataList 数组保存的结构数。 指定输出时，例程可以返回数据的控件数，其中包括当前设置为 ON 的所有按钮和所有控件值。

[in] PreparsedData

指向与位于 报表的 HID 报表关联的顶级集合 预先分析的数据的指针。

[in] Report

指向 HID 报表的指针。

[in] ReportLength

指定位于报表 报表的 HID 报表的大小（以字节为单位），该大小必须与集合 HIDP_CAPS 结构中 HidP_GetCaps 返回的指定报表类型的报表长度相等。

返回值

HidP_GetData 返回以下状态值之一：

返回代码 描述
HIDP_STATUS_SUCCESS
 已成功返回所有控件数据。
HIDP_STATUS_INVALID_REPORT_TYPE
 由 ReportType 指定的报表类型无效
HIDP_STATUS_INVALID_PREPARSED_DATA
 PreparsedData 指定的预分析数据无效
HIDP_STATUS_INVALID_REPORT_LENGTH
 HID 报表的大小（以字节为单位）不等于集合为指定报表类型的 HIDP_CAPS 结构中指定的长度。
HIDP_STATUS_REPORT_DOES_NOT_EXIST
 顶级集合没有指定类型的报表。
HIDP_STATUS_BUFFER_TOO_SMALL
 DataList 数组太小，无法描述所有按钮、当前设置为 ON 以及 HID 报表中的所有值。

言论

用户模式应用程序和内核模式驱动程序调用 HidP_MaxDataListLength，以确定 HidP_GetData 可以返回的最大HIDP_DATA结构数。

HidP_GetData 不返回 使用值数组的数据。

有关详细信息，请参阅 HID 集合。

要求

要求 价值
最低支持的客户端 在 Windows 2000 及更高版本的 Windows 中可用。
目标平台 普遍
标头 hidpi.h （包括 Hidpi.h）
库 Hidparse.lib
IRQL <= DISPATCH_LEVEL

另请参阅

HIDP_DATA

HidP_MaxDataListLength

HidP_SetData

_HIDP_PREPARSED_DATA