次の方法で共有

HidP_GetData関数 (hidpi.h)

HidP_GetData ルーチンは、指定されたレポートについて、現在 ON (1) に設定されているすべての HID コントロール ボタンの データ インデックスを識別する HIDP_DATA 構造体の配列、およびすべての HID コントロール値に関連付けられているデータ インデックスとデータを返します。

構文

NTSTATUS HidP_GetData(
  [in]      HIDP_REPORT_TYPE     ReportType,
  [out]     PHIDP_DATA           DataList,
  [in, out] PULONG               DataLength,
  [in]      PHIDP_PREPARSED_DATA PreparsedData,
  [in]      PCHAR                Report,
  [in]      ULONG                ReportLength
);

パラメーター

[in] ReportType

レポート にある HID レポートの種類を示す HIDP_REPORT_TYPE 列挙子の値指定します。

[out] DataList

現在 ON に設定されているすべてのボタンと値に関連付けられているデータに関する情報を返すためにルーチンが使用する、HIDP_DATA構造体の呼び出し元によって割り当てられた配列を指定します。

[in, out] DataLength

入力時に、呼び出し元によって割り当てられた dataList 配列が保持する構造体 数を指定します。 出力時に、ルーチンがデータを返すことができるコントロールの数を指定します。これには、現在 ON に設定されているすべてのボタンとすべてのコントロール値が含まれます。

[in] PreparsedData

レポート にある HID レポートに関連付けられた最上位レベルのコレクションの 準備データポインター。

[in] Report

HID レポートへのポインター。

[in] ReportLength

Reportにある HID レポートのサイズ (バイト単位) を指定します。これは、コレクションの HIDP_CAPS 構造体で HidP_GetCaps によって返される指定されたレポートの種類のレポートの長さと同じである必要があります。

戻り値

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

リターン コード 形容
HIDP_STATUS_SUCCESS
 すべてのコントロール データが正常に返されました。
HIDP_STATUS_INVALID_REPORT_TYPE
 ReportType で指定されたレポートの種類が無効です
HIDP_STATUS_INVALID_PREPARSED_DATA
 PreparesedData で指定された準備済みデータが無効です
HIDP_STATUS_INVALID_REPORT_LENGTH
 HID レポートのサイズ (バイト単位) は、指定したレポートの種類のコレクションの HIDP_CAPS 構造体で指定された長さと等しくありません。
HIDP_STATUS_REPORT_DOES_NOT_EXIST
 最上位のコレクションには、指定した型のレポートがありません。
HIDP_STATUS_BUFFER_TOO_SMALL
 DataList 配列が小さすぎて、現在 ON に設定されているすべてのボタンと HID レポート内のすべての値を記述できません。

備考

ユーザー モード アプリケーションとカーネル モード ドライバーは、HidP_MaxDataListLength を呼び出して、HidP_GetData 返すことができるHIDP_DATA構造体の最大数を決定します。

HidP_GetData は、使用値配列のデータを返しません。

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

必要条件

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

関連項目

HIDP_DATA

HidP_MaxDataListLength

HidP_SetData

_HIDP_PREPARSED_DATA