英語で読む

次の方法で共有

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 が 0 以外の場合は、この使用ページを指定するボタンのみが返されます。

[in] LinkCollection

検索条件として リンク コレクション を指定します。 LinkCollection が 0 以外の場合は、このリンク コレクションの一部であるボタンのみが返されます。

[in] Usage

検索条件として HID 使用法 を指定します。 使用法 が 0 以外の場合は、この使用法を指定するボタンのみが返されます。

[out] ButtonCaps

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

[in, out] ButtonCapsLength

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

[in] PreparsedData

最上位のコレクションの準備済みデータへのポインター。

戻り値

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

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

備考

ButtonCaps 配列の必要なサイズは、最上位のコレクションの HIDP_CAPS 構造体のメンバーNumberXxxButtonCaps によって指定されます。

HidP_GetSpecificButtonCapsを呼び出すときは、UsagePage 、Usage、および LinkCollection に 0 を指定すると、HidP_GetButtonCapsの呼び出しと同じになります。

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

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

必要条件

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

関連項目

HIDP_BUTTON_CAPS

HidP_GetButtonCaps

HidP_GetCaps

_HIDP_PREPARSED_DATA