HidP_SetUsageValue関数 (hidpi.h)

  • [アーティクル]

HidP_SetUsageValue ルーチンは、指定した HID レポートに HID コントロール値を設定します。

構文

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

パラメーター

[in] ReportType

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

[in] UsagePage

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

[in] LinkCollection

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

[in] Usage

使用法を指定します。

[in] UsageValue

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

[in] PreparsedData

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

[in, out] Report

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

[in] ReportLength

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

戻り値

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

リターン コード 説明
HIDP_STATUS_SUCCESS
 ルーチンは、使用値を正常に設定しました。
HIDP_STATUS_INCOMPATIBLE_REPORT_ID
 使用状況は、指定したレポートには存在しませんが、指定した種類の別のレポートに存在します。
HIDP_STATUS_INVALID_PREPARSED_DATA
 準備されたデータが無効です。
HIDP_STATUS_REPORT_DOES_NOT_EXIST
 指定した型のレポートはありません。
HIDP_STATUS_USAGE_NOT_FOUND
 使用状況は、指定したレポートの種類のレポートには存在しません。
HIDP_STATUS_INVALID_REPORT_LENGTH
 レポートの長さが無効です。
HIDP_STATUS_INVALID_REPORT_TYPE
 指定したレポートの種類が無効です。

注釈

HidP_SetUsageValue ルーチンは値に署名しません。 ユーザー モード アプリケーションまたはカーネル モード ドライバーは、この値の HIDP_VALUE_CAPS 構造体で指定された位置にある値に署名するか、 HidP_SetScaledUsageValueを呼び出す必要があります。

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

要件

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

こちらもご覧ください

HIDP_VALUE_CAPS

HidP_SetScaledUsageValue

_HIDP_PREPARSED_DATA