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 列舉值,指出位於 報表的報表類型。
[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傳回之指定報表類型的報表長度。
傳回值
如果 HidP_UnsetUsages成功設定為 UsageList中的所有使用量,HidP_UnsetUsages會傳回HIDP_STATUS_SUCCESS。
如果 其中一個輸入參數無效,HidP_UnsetUsages會傳回下列其中一個狀態值:
傳回碼 | Description |
---|---|
|
PreparsedData 所指定的預先剖析數據無效。 |
|
報表長度無效。 |
|
報表類型無效。 |
|
集合不包含指定型別的報表。 |
如果 無法使用 UsageList 中的其中一個用法,HidP_UnsetUsages會傳回下列其中一個狀態值:
傳回碼 | Description |
---|---|
|
使用量已設定為 OFF。 |
|
使用方式不包含在指定的報表中,但包含在指定類型的另一個報表中。 |
|
例程在指定類型的任何報表中找不到使用方式。 |
備註
HidP_UnsetUsages 設定 UsageLength ,如下所示:
如需詳細資訊,請參閱 HID 集合。
規格需求
需求 | 值 |
---|---|
最低支援的用戶端 | 適用於 Windows 2000 和更新版本的 Windows。 |
目標平台 | Universal |
標頭 | hidpi.h (包含 Hidpi.h) |
程式庫 | Hidparse.lib |
IRQL | <=DISPATCH_LEVEL |