HidP_SetScaledUsageValue関数 (hidpi.h)

[アーティクル]
02/26/2024

HidP_SetScaledUsageValue ルーチンは、符号付きおよびスケーリングされた物理番号を HID 使用法の論理値に変換し、指定した HID レポートの使用状況値を設定します。

構文

NTSTATUS HidP_SetScaledUsageValue(
  [in]      HIDP_REPORT_TYPE     ReportType,
  [in]      USAGE                UsagePage,
  [in]      USHORT               LinkCollection,
  [in]      USAGE                Usage,
  [in]      LONG                 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_SetScaledUsageValue は、次のいずれかの状態値を返します。

リターンコード	説明
HIDP_STATUS_SUCCESS	ルーチンは、使用値を正常に設定しました。
HIDP_STATUS_BAD_LOG_PHY_VALUES	使用量には、スケーリングを妨げる無効な論理範囲または物理範囲があります。
HIDP_STATUS_VALUE_OUT_OF_RANGE	指定された物理値が範囲外であり、使用法に null 値がありません。
HIDP_STATUS_INVALID_REPORT_LENGTH	レポートの長さが無効です。
HIDP_STATUS_INVALID_REPORT_TYPE	指定されたレポートの種類が無効です。
HIDP_STATUS_INCOMPATIBLE_REPORT_ID	使用状況は、指定したレポートには存在しませんが、指定した種類の別のレポートに存在します。
HIDP_STATUS_INVALID_PREPARSED_DATA	準備されたデータが無効です。
HIDP_STATUS_USAGE_NOT_FOUND	使用状況は、指定されたレポートの種類のレポートには存在しません。
HIDP_STATUS_NULL	指定された物理値が範囲外であり、使用法に null 値があり、ルーチンによって null 値が設定されます。

注釈

HidP_SetScaledUsageValue 符号ビットを設定します。

ルーチンがHIDP_STATUS_INCOMPATIBLE_REPORT_IDを返す場合、指定されたレポートには使用法が含まれます。ただし、ユーザーモードアプリケーションまたはカーネルモードドライバーは、ゼロ初期化レポートで使用状況を設定できます。 HID レポートの初期化に関するページを参照してください。

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

要件

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