HidP_UnsetUsages函式（hidpi.h）

發行項
02/07/2025

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

與位於 Report之報表相關聯之最上層集合預先剖析數據指標。

[in] Report

報表的指標。

[in] ReportLength

指定位於 Report之報表的大小，其必須等於集合 HIDP_CAPS 結構中傳回之指定報表 HidP_GetCaps 類型的報表長度。

傳回值

如果 HidP_UnsetUsages 成功設定為 OFF UsageList中的所有使用量，HidP_UnsetUsages 會傳回HIDP_STATUS_SUCCESS。

如果其中一個輸入參數無效，HidP_UnsetUsages 會傳回下列其中一個狀態值：

傳回碼	描述
HIDP_STATUS_INVALID_PREPARSED_DATA	PreparsedData 所指定的預先剖析數據無效。
HIDP_STATUS_INVALID_REPORT_LENGTH	報表長度無效。
HIDP_STATUS_INVALID_REPORT_TYPE	報表類型無效。
HIDP_STATUS_REPORT_DOES_NOT_EXIST	集合不包含指定型別的報表。

HidP_UnsetUsages 如果無法將 UsageList 中的其中一個使用量設定為 OFF，則會傳回下列其中一個狀態值：

傳回碼	描述
HIDP_STATUS_BUTTON_NOT_PRESSED	使用量已設定為 OFF。
HIDP_STATUS_INCOMPATIBLE_REPORT_ID	使用方式未包含在指定的報表中，但包含在指定型別的另一個報表中。
HIDP_STATUS_USAGE_NOT_FOUND	例程在指定型別的任何報表中找不到使用方式。

言論

HidP_UnsetUsages 會設定 usageLength ，如下所示：

如需詳細資訊，請參閱 HID 集合。

要求

要求	價值
最低支援的用戶端	適用於 Windows 2000 和更新版本的 Windows。
目標平臺	普遍
標頭	hidpi.h （包括 Hidpi.h）
連結庫	Hidparse.lib
IRQL	<=DISPATCH_LEVEL