HidP_SetButtonArray 函式會透過 HIDP_BUTTON_ARRAY_DATA 結構的數位來設定按鈕的狀態。
語法
NTSTATUS HidP_SetButtonArray(
HIDP_REPORT_TYPE ReportType,
USAGE UsagePage,
USHORT LinkCollection,
USAGE Usage,
PHIDP_BUTTON_ARRAY_DATA ButtonData,
USHORT ButtonDataLength,
PHIDP_PREPARSED_DATA PreparsedData,
PCHAR Report,
ULONG ReportLength
);
參數
ReportType
HidP_Output 或 HidP_FeatureHIDP_REPORT_TYPE 列舉的值。
UsagePage
指定使用量所參考的使用量頁面。
LinkCollection
（選擇性）這個值可用來區分兩個可能具有相同 UsagePage 和 Usage 但存在於不同集合中的字位。 如果值是HIDP_LINK_COLLECTION_UNSPECIFIED，則不論位置為何，都會傳回符合 UsagePage 且 Usage 相符的第一個找到按鈕數位。 如果值是HIDP_LINK_COLLECTION_ROOT，則會傳回根集合中第一個找到的按鈕陣列，符合 UsagePage，並傳回 Usage。
Usage
將設定其按鈕陣列 HidP_SetButtonArray 的使用方式。
ButtonData
緩衝區，其中包含要設定為按鈕數位中的值。
ButtonDataLength
ButtonData 緩衝區中的元素數目。
PreparsedData
從 HIDCLASS 傳回的剖析資料。
Report
報表封包。 第一個字節 必須 為 ReportId。
ReportLength
指定報表封包的長度，以位元組為單位。
傳回值
HidP_SetButtonArray 會傳回下列其中一個狀態值：
| 傳回碼 | 描述 |
|---|---|
| HIDP_STATUS_SUCCESS | 已成功設定報表封包中的按鈕陣列 |
| HIDP_STATUS_INVALID_REPORT_TYPE | ReportType 無效 |
| HIDP_STATUS_INVALID_PREPARSED_DATA | PreparsedData 無效 |
| HIDP_STATUS_INVALID_REPORT_LENGTH | 報表封包的長度不等於 指定之 ReportType HIDP_CAPS 結構中指定的長度 |
| HIDP_STATUS_REPORT_DOES_NOT_EXIST | 指定的 ReportType 沒有此裝置上的報告 |
| HIDP_STATUS_NOT_BUTTON_ARRAY | 指定的控制項不是按鈕數位 |
| HIDP_STATUS_INCOMPATIBLE_REPORT_ID | 指定的使用方式頁面、使用方式和連結集合存在於報表中，其報表標識符與傳入的報表不同 |
| HIDP_STATUS_USAGE_NOT_FOUND | 此 ReportType 的任何報表中都沒有使用方式頁面、使用方式和連結集合組合 |
| HIDP_STATUS_DATA_INDEX_OUT_OF_RANGE | 其中一個所提供 HIDP_BUTTON_ARRAY_DATA 結構的 ArrayIndex 超出此按鈕陣列的有效範圍 |
言論
HidP_SetButtonArray 設定所找到之第一個按鈕陣列的按鈕狀態，在指定的 LinkCollection內，為指定的 報表提供 使用量。
呼叫端應該使用 HidP_GetVersion 來判斷此函式是否可用。 HidP_SetButtonArray 只有在 HidP_GetVersion 傳回兩個或更新的值時，才能使用。 第二版的 API 對應至 Windows 11。
當描述主要專案之使用順序中的最後一個使用方式時，必須重複按鈕陣列，因為定義的使用量比針對指定的主要專案宣告的 ReportCount 少。 在此情況下，會針對該使用量配置單一 HIDP_BUTTON_CAPS，並將 HIDP_BUTTON_CAPS 的 ReportCount 設定為反映使用量所參考的欄位數目。
描述按鈕陣列的 HIDP_BUTTON_CAPS 一律 ReportCount 大於一個。 如果 ReportCount 等於一個，則它不是按鈕數位，而且不能與 HidP_SetButtonArray搭配使用。 如需詳細資訊，請參閱 HidP_SetUsages。
要求
| 要求 | 價值 |
|---|---|
| 標頭 | hidpi.h |