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

こちらもご覧ください

HIDP_BUTTON_CAPS

HidP_GetButtonCaps

HidP_GetCaps

_HIDP_PREPARSED_DATA