HidP_UnsetUsages函数 (hidpi.h)
HidP_UnsetUsages例程在 HID 报表中将指定的 HID 控件按钮用法设置为 OFF (零) 。
语法
NTSTATUS HidP_UnsetUsages(
[in] HIDP_REPORT_TYPE ReportType,
[in] USAGE UsagePage,
[in, optional] 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, optional] LinkCollection
指定包含用法 的链接集合 。 如果 LinkCollection 不为零,则例程仅设置此链接集合中的用法(如果存在)。 如果 LinkCollection 为零,则例程为它在与 PreparsedData 关联的顶级集合中找到的每个用法设置第一个用法。
[in, out] UsageList
指向要设置为 OFF 的用法数组的指针。
[in, out] UsageLength
在输入时指定 UsageList 中的用法数。 有关输出值的信息,请参阅“备注”部分。
[in] PreparsedData
指向与报表中的报表关联的顶级集合的预先分析数据的指针。
[in] Report
指向报表的指针。
[in] ReportLength
指定位于 Report 的报表的大小(以字节为单位),该大小必须等于集合HIDP_CAPS结构中 返回HidP_GetCaps 指定报表类型的 报表 长度。
返回值
如果成功将 UsageList 中的所有用法设置为 OFF,HidP_UnsetUsages将返回HIDP_STATUS_SUCCESS。
如果 其中一个输入参数无效,HidP_UnsetUsages将返回以下状态值之一:
返回代码 | 说明 |
---|---|
|
PreparsedData 指定的预分析数据无效。 |
|
报表长度无效。 |
|
报表类型无效。 |
|
集合不包含指定类型的报表。 |
如果无法 将 UsageList 中的某个用法设置为 OFF,HidP_UnsetUsages将返回以下状态值之一:
返回代码 | 说明 |
---|---|
|
用法已设置为 OFF。 |
|
用法不包含在指定的报表中,但包含在指定类型的另一个报表中。 |
|
例程未在任何指定类型的报告中找到用法。 |
注解
HidP_UnsetUsages 按如下所示设置 UsageLength :
有关详细信息,请参阅 HID 集合。
要求
要求 | 值 |
---|---|
最低受支持的客户端 | 在 Windows 2000 和更高版本的 Windows 中可用。 |
目标平台 | 通用 |
标头 | hidpi.h (包括 Hidpi.h) |
Library | Hidparse.lib |
IRQL | <=DISPATCH_LEVEL |