HidP_GetSpecificButtonCaps函式 (hidpi.h)

HidP_GetSpecificButtonCaps例程會傳回按鈕功能陣列,描述最上層集合中符合指定選取準則的所有 HID 控制按鈕。

語法

NTSTATUS HidP_GetSpecificButtonCaps(
  [in]      HIDP_REPORT_TYPE     ReportType,
  [in]      USAGE                UsagePage,
  [in]      USHORT               LinkCollection,
  [in]      USAGE                Usage,
  [out]     PHIDP_BUTTON_CAPS    ButtonCaps,
  [in, out] PUSHORT              ButtonCapsLength,
  [in]      PHIDP_PREPARSED_DATA PreparsedData
);

參數

[in] ReportType

指定可識別報表類型的 HIDP_REPORT_TYPE 列舉值。

[in] UsagePage

將使用量頁面指定為搜尋準則。 如果 UsagePage 不是零,則只會傳回指定此使用頁面的按鈕。

[in] LinkCollection

指定 連結集合 做為搜尋準則。 如果 LinkCollection 不是零,則只會傳回屬於此連結集合一部分的按鈕。

[in] Usage

指定 HID 使用 方式做為搜尋準則。 如果 Usage 是非零的,則只會傳回指定此使用量的按鈕。

[out] ButtonCaps

呼叫端配置的緩衝區指標,其中例程會針對指定的報表類型傳回按鈕功能陣列。

[in, out] ButtonCapsLength

指定 ButtonCaps 所提供緩衝區之輸入的長度,以陣列元素為單位。 輸出時,此參數會設定為例程實際傳回的項目數。

[in] PreparsedData

最上層集合預先分析數據的指標。

傳回值

HidP_GetSpecificButtonCaps傳 回下列其中一個狀態值:

傳回碼 Description
HIDP_STATUS_SUCCESS
例程已成功傳回功能數據。
HIDP_STATUS_INVALID_PREPARSED_DATA
預先分析的數據無效。

備註

ButtonCaps 陣列的必要大小是由最上層集合之HIDP_CAPS結構的 NumberXxxButtonCaps 成員所指定。

呼叫 HidP_GetSpecificButtonCaps時,針對 UsagePageUsageLinkCollection 指定零相當於呼叫 HidP_GetButtonCaps

如需集合功能的詳細資訊,請參閱 取得集合資訊

另請參閱 HID 集合

規格需求

需求
最低支援的用戶端 可在 Windows 2000 和更新版本的 Windows 中使用。
目標平台 Universal
標頭 hidpi.h (包含 Hidpi.h)
程式庫 Hidparse.lib
IRQL PASSIVE_LEVEL

另請參閱

HIDP_BUTTON_CAPS

HidP_GetButtonCaps

HidP_GetCaps

_HIDP_PREPARSED_DATA