HidP_GetButtonCaps 函数 (hidpi.h)

HidP_GetButtonCaps例程返回一个按钮功能数组,该数组描述指定类型 HID 报表的顶级集合中的所有 HID 控件按钮。

语法

NTSTATUS HidP_GetButtonCaps(
  [in]      HIDP_REPORT_TYPE     ReportType,
  [out]     PHIDP_BUTTON_CAPS    ButtonCaps,
  [in, out] PUSHORT              ButtonCapsLength,
  [in]      PHIDP_PREPARSED_DATA PreparsedData
);

参数

[in] ReportType

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

[out] ButtonCaps

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

[in, out] ButtonCapsLength

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

[in] PreparsedData

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

返回值

HidP_GetButtonCaps 返回以下状态值之一:

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

注解

HidP_GetButtonCaps 返回指定报表类型的顶级集合中所有按钮的功能。

ButtonCapsLength 应设置为由 HidP_GetCaps 返回的 HIDP_CAPS 结构中的 Number Xxx ButtonCaps 成员的值,其中 Xxx 指定报告类型。

若要获取按 使用情况使用情况页链接集合选择的按钮功能的子集,请使用 HidP_GetSpecificButtonCaps

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

另请参阅 HID 集合

要求

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

另请参阅

HIDP_BUTTON_CAPS

HidP_GetCaps

HidP_GetSpecificButtonCaps

_HIDP_PREPARSED_DATA