Share via

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 で使用できます。
対象プラットフォーム ユニバーサル
Header hidpi.h (Hidpi.h を含む)
Library Hidparse.lib
IRQL PASSIVE_LEVEL

こちらもご覧ください

HIDP_BUTTON_CAPS

HidP_GetCaps

HidP_GetSpecificButtonCaps

_HIDP_PREPARSED_DATA