HidP_SetUsages函式 (hidpi.h)

發行項
02/26/2024

HidP_SetUsages例程會在 HID 報表中設定 ON (1) 指定的 HID 控制項按鈕。

語法

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 列舉值，指出位於 報表的報表類型。

[in] UsagePage

指定 UsageList 所指定使用量的使用方式頁面。

[in] LinkCollection

指定包含使用方式的連結集合。如果 LinkCollection 為非零，則例程只會在此連結集合中設定使用方式。如果 LinkCollection 為零，例程會設定與 PreparsedData 相關聯之最上層集合中每個指定使用量的第一個使用方式。

[in, out] UsageList

使用方式陣列的指標。

[in, out] UsageLength

在輸入上，指定 UsageList中的使用量數目。如需輸出值的相關信息，請參閱一節。

[in] PreparsedData

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

[in] Report

報表的指標。

[in] ReportLength

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

傳回值

HidP_SetUsages 傳回下列其中一個狀態值：

傳回碼	Description
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 中使用。
目標平台	Universal
標頭	hidpi.h (包含 Hidpi.h)
程式庫	Hidparse.lib
IRQL	<= DISPATCH_LEVEL