次の方法で共有


HidP_GetButtonCaps関数 (hidpi.h)

HidP_GetButtonCaps ルーチンは、指定した種類の HID レポートに 最上位レベルのコレクション内のすべての HID コントロール ボタンを記述する ボタン機能配列 を返します。

構文

NTSTATUS HidP_GetButtonCaps(
  [in]      HIDP_REPORT_TYPE     ReportType,
  [out]     PHIDP_BUTTON_CAPS    ButtonCaps,
  [in, out] PUSHORT              ButtonCapsLength,
  [in]      PHIDP_PREPARSED_DATA PreparsedData
);

パラメーター

[in] ReportType

レポートの種類を識別する HIDP_REPORT_TYPE 列挙子の値を指定します。

[out] ButtonCaps

指定したレポートの種類のボタン機能配列を返すためにルーチンが使用する呼び出し元によって割り当てられたバッファーへのポインター。

[in, out] ButtonCapsLength

ButtonCapsで提供されるバッファーの入力の長さを配列要素で指定します。 出力時に、このパラメーターはルーチンが返す要素の実際の数に設定されます。

[in] PreparsedData

最上位レベルのコレクションの 準備されたデータへのポインター。

戻り値

HidP_GetButtonCaps は、次のいずれかの状態値を返します。

リターン コード 形容
HIDP_STATUS_SUCCESS
このルーチンは、機能データを正常に返しました。
HIDP_STATUS_INVALID_PREPARSED_DATA
準備されたデータが無効です。

備考

HidP_GetButtonCaps は、指定したレポートの種類の最上位レベル コレクション内のすべてのボタンの機能を返します。

ButtonCapsLength は、HidP_GetCapsによって返される HIDP_CAPS 構造体の NumberXxxButtonCaps メンバーの値に設定する必要があります。ここで、Xxx レポートの種類を指定します。

ボタン機能のサブセットを取得するには、使用 使用状況ページ、またはリンク コレクション 選択して、HidP_GetSpecificButtonCapsを使用します。

コレクションの機能の詳細については、「コレクション情報の取得 を参照してください。

HID コレクションの も参照してください。

必要条件

要件 価値
サポートされる最小クライアント Windows 2000 以降のバージョンの Windows で使用できます。
ターゲット プラットフォーム 万国
ヘッダー hidpi.h (Hidpi.h を含む)
ライブラリ Hidparse.lib
IRQL PASSIVE_LEVEL

関連項目

HIDP_BUTTON_CAPS

HidP_GetCaps

HidP_GetSpecificButtonCaps

_HIDP_PREPARSED_DATA