次の方法で共有

HidP_SetUsageValueArray関数 (hidpi.h)

  • [アーティクル]

HidP_SetUsageValueArray ルーチンは、指定した HID レポート 使用値配列 HID コントロールを設定します。

構文

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

パラメーター

[in] ReportType

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

[in] UsagePage

使用状況の 使用状況ページを指定します。

[in] LinkCollection

使用法を含む リンク コレクション を指定します。 LinkCollection が 0 以外の場合、ルーチンは、このリンク コレクション内に存在する場合にのみ、使用法を設定します。 LinkCollection が 0 の場合、ルーチンは、PreparesedDataに関連付けられている 最上位レベルのコレクションで最初に検出される使用法を設定します。

[in] Usage

使用法を指定します。

[in] UsageValue

使用法値配列に関連付けられているデータを含む呼び出し元によって割り当てられたバッファーへのポインター。

[in] UsageValueByteLength

UsageValue バッファーの長さをバイト単位で指定します。

[in] PreparsedData

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

[in, out] Report

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

[in] ReportLength

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

戻り値

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

リターン コード 形容
HIDP_STATUS_SUCCESS
 ルーチンは、使用値を正常に設定しました。
HIDP_STATUS_INVALID_REPORT_LENGTH
 レポートの長さが無効です。
HIDP_STATUS_INVALID_REPORT_TYPE
 指定したレポートの種類が無効です。
HIDP_STATUS_BUFFER_TOO_SMALL
 UsageValue バッファーのサイズ (バイト単位) が小さすぎます。
HIDP_STATUS_INCOMPATIBLE_REPORT_ID
 使用状況は指定されたレポートには存在しませんが、指定した種類の別のレポートに存在します。
HIDP_STATUS_NOT_VALUE_ARRAY
 指定された使用法は、使用値の配列ではありません。
HIDP_STATUS_INVALID_PREPARSED_DATA
 準備されたデータが無効です。
HIDP_STATUS_REPORT_DOES_NOT_EXIST
 指定した種類のレポートはありません。
HIDP_STATUS_NOT_IMPLEMENTED
 使用値配列に指定されたデータ フィールドのレポート サイズは、8 ビットの倍数ではありません。
HIDP_STATUS_USAGE_NOT_FOUND
 使用状況は、指定したレポートの種類のレポートには存在しません。

備考

UsageValue バッファーの必要なサイズ (バイト単位) は、使用値配列の HIDP_VALUE_CAPS 構造体の BitSize と reportCount メンバーを乗算し、結果を最も近いバイトに切り上げて決定します。

HidP_SetUsageValueArray は、配列の各データ フィールドが 8 ビットの倍数である使用値配列のみをサポートします。

呼び出し元は、レポートで発生する必要があるとおりに、UsageValue バッファーを設定する必要があります。

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

必要条件

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

関連項目

HidP_SetScaledUsageValue

HidP_SetUsageValue

_HIDP_PREPARSED_DATA