HidP_GetValueCaps関数 (hidpi.h)

[アーティクル]
02/29/2024

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

構文

NTSTATUS HidP_GetValueCaps(
  [in]      HIDP_REPORT_TYPE     ReportType,
  [out]     PHIDP_VALUE_CAPS     ValueCaps,
  [in, out] PUSHORT              ValueCapsLength,
  [in]      PHIDP_PREPARSED_DATA PreparsedData
);

パラメーター

[in] ReportType

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

[out] ValueCaps

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

[in, out] ValueCapsLength

ValueCaps バッファーの入力時の配列要素の長さを指定します。出力時に、ルーチンは ValueCapsLength を、実際に返される要素の数に設定します。

[in] PreparsedData

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

戻り値

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

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

注釈

ValueCapsLength の正しい長さは、最上位のコレクションの HIDP_CAPS 構造体の NumberXxxValueCaps メンバーによって指定されます。

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

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

要件

要件	値
サポートされている最小のクライアント	Windows 2000 以降のバージョンの Windows で使用できます。
対象プラットフォーム	ユニバーサル
Header	hidpi.h (Hidpi.h を含む)
Library	Hidparse.lib
IRQL	<= DISPATCH_LEVEL