HidP_GetSpecificValueCaps関数 (hidpi.h)

[アーティクル]
08/07/2023

HidP_GetSpecificValueCaps ルーチンは、指定された選択基準を満たすすべての HID コントロール値を記述する値機能配列を返します。

構文

NTSTATUS HidP_GetSpecificValueCaps(
  [in]      HIDP_REPORT_TYPE     ReportType,
  [in]      USAGE                UsagePage,
  [in]      USHORT               LinkCollection,
  [in]      USAGE                Usage,
  [out]     PHIDP_VALUE_CAPS     ValueCaps,
  [in, out] PUSHORT              ValueCapsLength,
  [in]      PHIDP_PREPARSED_DATA PreparsedData
);

パラメーター

[in] ReportType

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

[in] UsagePage

使用ページを検索条件として指定します。 UsagePage が 0 以外の場合は、この使用状況ページを指定する値のみが返されます。

[in] LinkCollection

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

[in] Usage

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

[out] ValueCaps

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

[in, out] ValueCapsLength

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

[in] PreparsedData

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

戻り値

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

リターンコード	NT 状態の値	説明
HIDP_STATUS_SUCCESS	0x00110000	ルーチンは、機能データを正常に返しました。
HIDP_STATUS_INVALID_PREPARSED_DATA	0xc0110001	準備されたデータが無効です。
HIDP_STATUS_USAGE_NOT_FOUND	0xc0110004	使用状況は、指定したレポートの種類のレポートには存在しません。

注釈

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

HidP_GetSpecificValueCapsを呼び出すときに、UsagePage、Usage、および LinkCollection に 0 を指定することは、HidP_GetValueCapsを呼び出すことと同じです。

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

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

要件

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