HidP_GetSpecificButtonCaps函数 (hidpi.h)

HidP_GetSpecificButtonCaps 例程返回一个 按钮功能数组,该数组描述满足指定选择条件 顶级 集合中的所有 HID 控件按钮。

语法

NTSTATUS HidP_GetSpecificButtonCaps(
  [in]      HIDP_REPORT_TYPE     ReportType,
  [in]      USAGE                UsagePage,
  [in]      USHORT               LinkCollection,
  [in]      USAGE                Usage,
  [out]     PHIDP_BUTTON_CAPS    ButtonCaps,
  [in, out] PUSHORT              ButtonCapsLength,
  [in]      PHIDP_PREPARSED_DATA PreparsedData
);

参数

[in] ReportType

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

[in] UsagePage

将使用情况页指定为搜索条件。 如果 UsagePage 为非零,则仅返回指定此使用情况页的按钮。

[in] LinkCollection

链接集合指定为搜索条件。 如果 LinkCollection 为非零,则仅返回属于此链接集合的按钮。

[in] Usage

指定 HID 用法 作为搜索条件。 如果 使用情况 为非零,则仅返回指定此用法的按钮。

[out] ButtonCaps

指向调用方分配的缓冲区的指针,在该缓冲区中,例程返回指定报表类型的按钮功能数组。

[in, out] ButtonCapsLength

指定在 ButtonCaps提供的缓冲区的输入长度(以数组元素为单位)。 在输出中,此参数设置为例程实际返回的元素数。

[in] PreparsedData

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

返回值

HidP_GetSpecificButtonCaps 返回以下状态值之一:

返回代码 描述
HIDP_STATUS_SUCCESS
例程已成功返回功能数据。
HIDP_STATUS_INVALID_PREPARSED_DATA
预先分析的数据无效。

言论

ButtonCaps 数组的所需大小是由顶级集合 HIDP_CAPS 结构的 NumberXxxButtonCaps 成员指定的。

调用 HidP_GetSpecificButtonCaps时,为 usagePageUsage指定零,LinkCollection 等效于调用 HidP_GetButtonCaps

有关集合功能的详细信息,请参阅 获取集合信息

另请参阅 HID 集合

要求

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

另请参阅

HIDP_BUTTON_CAPS

HidP_GetButtonCaps

HidP_GetCaps

_HIDP_PREPARSED_DATA