HidP_GetUsagesEx函数（hidpi.h）

项目
02/07/2025

HidP_GetUsagesEx 例程返回在 HID 报表中设置为 ON 的所有 HID 控件按钮用法的列表。

语法

NTSTATUS HidP_GetUsagesEx(
  [in]      HIDP_REPORT_TYPE     ReportType,
  [in]      USHORT               LinkCollection,
  [in, out] PUSAGE_AND_PAGE      ButtonList,
  [in, out] ULONG                *UsageLength,
  [in]      PHIDP_PREPARSED_DATA PreparsedData,
  [in]      PCHAR                Report,
  [in]      ULONG                ReportLength
);

参数

[in] ReportType

指定标识报表类型的 HIDP_REPORT_TYPE 枚举器值。

[in] LinkCollection

指定按钮用法链接集合。如果 LinkCollection 为非零，则例程仅返回有关此链接集合包含的按钮的信息;否则，如果 LinkCollection 为零，则例程将返回与 PreparsedData关联的顶级集合中的所有按钮的相关信息。

[in, out] ButtonList

指向调用方分配的缓冲区的指针，该缓冲区例程用于返回使用情况和使用情况页设置为 ON（1）的每个按钮的标识符。

[in, out] UsageLength

指定 ButtonList 缓冲区的输入、长度（以数组元素为单位）。指定输出中当前设置为 ON 的数字用法。

[in] PreparsedData

指向顶级集合预先分析的数据的指针。

[in] Report

指向包含按钮数据的报表的指针。

[in] ReportLength

指定位于报表报表的长度（以字节为单位）。

返回值

HidP_GetUsagesEx 返回以下状态值之一：

返回代码	描述
HIDP_STATUS_SUCCESS	例程已成功返回设置为 ON 的所有按钮用法。
HIDP_INVALID_REPORT_LENGTH	报表长度无效。
HIDP_INVALID_REPORT_TYPE	指定的报表类型无效。
HIDP_STATUS_BUFFER_TOO_SMALL	UsageList 缓冲区太小，无法保留指定报表中当前设置为 ON 的所有用法。
HIDP_STATUS_INCOMPATIBLE_REPORT_ID	集合包含指定类型的报表中的按钮，但指定报表中没有此类用法。
HIDP_STATUS_INVALID_PREPARSED_DATA	预先分析的数据无效。

言论

用户模式应用程序和内核模式驱动程序调用 HidP_MaxUsageListLength 以确定为指定报表类型返回的最大按钮数。或者，应用程序或驱动程序可以调用 HidP_GetUsagesEx 并将 （*UsageLength） 设置为零，以返回 UsageLength中所需的长度。换句话说，UsageLength 应该是指向 ULONG 值 0 获取所需长度的有效指针。

应用程序或驱动程序从顶级集合 HIDP_CAPS 结构中的 XxxReportByteLength 成员来确定所需的报表长度。

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

要求

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