HidP_SetUsages 函数 (hidpi.h)

项目
02/26/2024

HidP_SetUsages例程在 HID 报表中设置指定的 HID 控件按钮 ON (1) 。

语法

NTSTATUS HidP_SetUsages(
  [in]      HIDP_REPORT_TYPE     ReportType,
  [in]      USAGE                UsagePage,
  [in]      USHORT               LinkCollection,
  [in, out] PUSAGE               UsageList,
  [in, out] PULONG               UsageLength,
  [in]      PHIDP_PREPARSED_DATA PreparsedData,
  [in]      PCHAR                Report,
  [in]      ULONG                ReportLength
);

参数

[in] ReportType

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

[in] UsagePage

指定 UsageList 指定的用法的使用情况页。

[in] LinkCollection

指定包含用法的链接集合。如果 LinkCollection 为非零值，则例程仅设置此链接集合中的用法（如果存在）。如果 LinkCollection 为零，则例程将设置与 PreparsedData 关联的顶级集合中每个指定用法的第一个用法。

[in, out] UsageList

指向用法数组的指针。

[in, out] UsageLength

在输入时指定 UsageList 中的用法数。有关输出值的信息，请参阅备注部分。

[in] PreparsedData

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

[in] Report

指向报表的指针。

[in] ReportLength

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

返回值

HidP_SetUsages 返回以下状态值之一：

返回代码	说明
HIDP_STATUS_SUCCESS	例程已成功设置使用值。
HIDP_STATUS_BUFFER_TOO_SMALL	无法设置按钮数组中的用法，因为该数组已完全设置。
HIDP_STATUS_INVALID_REPORT_LENGTH	报表长度无效。
HIDP_STATUS_INVALID_REPORT_TYPE	指定的报表类型无效。
HIDP_STATUS_INCOMPATIBLE_REPORT_ID	指定报表中不存在用法，但它确实存在于指定类型的其他报表中。
HIDP_STATUS_INVALID_PREPARSED_DATA	预分析的数据无效。
HIDP_STATUS_USAGE_NOT_FOUND	指定报表类型的任何报表中都不存在用法。

注解

如果 HidP_SetUsages 无法在 UsageList 中设置用法，则例程会将 UsageLength 设置为无法设置的使用情况的索引，并返回指示错误的状态值。

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

要求

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