HidP_GetUsageValue関数 (hidpi.h)

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

HidP_GetUsageValue ルーチンは、HID レポートの選択条件に一致する HID コントロール値に関連付けられているデータを抽出します。

構文

NTSTATUS HidP_GetUsageValue(
  [in]  HIDP_REPORT_TYPE     ReportType,
  [in]  USAGE                UsagePage,
  [in]  USHORT               LinkCollection,
  [in]  USAGE                Usage,
  [out] PULONG               UsageValue,
  [in]  PHIDP_PREPARSED_DATA PreparsedData,
  [in]  PCHAR                Report,
  [in]  ULONG                ReportLength
);

パラメーター

[in] ReportType

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

[in] UsagePage

値の使用法ページを指定します。

[in] LinkCollection

値を含むリンクコレクションを指定します。 LinkCollection が 0 以外の場合、ルーチンは、このリンクコレクション内の使用法のみを検索します。それ以外の場合、LinkCollection が 0 の場合、ルーチンは PreparsedData に関連付けられている最上位のコレクション内の使用法を検索します。

[in] Usage

値の使用法を指定します。

[out] UsageValue

ルーチンが値データを返すバッファーへのポインター。

[in] PreparsedData

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

[in] Report

値を含むレポートへのポインター。

[in] ReportLength

レポートにあるレポートの長さをバイト単位で指定 します。

戻り値

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

リターンコード	説明
HIDP_STATUS_SUCCESS	ルーチンは値データを正常に返しました。
HIDP_INVALID_REPORT_LENGTH	レポートの長さが無効です。
HIDP_INVALID_REPORT_TYPE	指定されたレポートの種類が無効です。
HIDP_STATUS_INCOMPATIBLE_REPORT_ID	コレクションには、指定した種類のレポート内の指定した使用状況ページの値が含まれていますが、指定したレポートにはそのような使用法はありません。
HIDP_STATUS_INVALID_PREPARSED_DATA	準備されたデータが無効です。
HIDP_STATUS_USAGE_NOT_FOUND	コレクションには、指定したレポートの種類のレポートで、指定した使用状況ページの値が含まれていません。

注釈

HidP_GetUsageValue は、値に署名したりスケーリングしたりしません。符号付き値を抽出するには、HidP_GetScaledUsageValueを使用 します。符号ビットを手動で割り当てるには、値の HIDP_VALUE_CAPS 構造内の情報から符号ビットの位置を決定できます。

HidP_GetUsageValue は、レポート数が 1 の使用状況の使用状況値を抽出するように設計されています。指定した使用状況のレポート数が 1 より大きい場合、使用法は使用状況値配列の一部になります。 HidP_GetUsageValue は、使用状況値配列の最初のデータ項目のみを返します。使用値配列内のすべてのデータ項目を抽出するには、 HidP_GetUsageValueArrayを使用します。

詳細については、「 HID コレクション」を参照してください。

要件

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