HidP_GetScaledUsageValue関数 (hidpi.h)
HidP_GetScaledUsageValue ルーチンは、HID レポートから抽出された HID コントロール値の符号付きおよびスケーリングされた結果を返します。
構文
NTSTATUS HidP_GetScaledUsageValue(
[in] HIDP_REPORT_TYPE ReportType,
[in] USAGE UsagePage,
[in] USHORT LinkCollection,
[in] USAGE Usage,
[out] PLONG UsageValue,
[in] PHIDP_PREPARSED_DATA PreparsedData,
[in] PCHAR Report,
[in] ULONG ReportLength
);
パラメーター
[in] ReportType
HID 使用法 値を含む HID レポートの種類を識別する HIDP_REPORT_TYPE 列挙子の値を指定します。
[in] UsagePage
抽出する値の使用状況ページを指定します。
[in] LinkCollection
抽出する値のリンク コレクション識別子を指定します。 LinkCollection 値が 0 の場合、最上位のコレクションが識別されます。
[in] Usage
抽出する値の使用法を指定します。
[out] UsageValue
ルーチンが符号付きおよびスケーリングされた値を返すバッファーへのポインター。
[in] PreparsedData
レポートにあるレポートを生成した
[in] Report
使用状況を含むレポートへのポインター。
[in] ReportLength
Reportにあるレポートの長さをバイト単位で指定します。
戻り値
HidP_GetScaledUsageValue は、次のいずれかの状態値を返します。
リターン コード | 形容 |
---|---|
HIDP_STATUS_SUCCESS | ルーチンは正常に値を返しました。 |
HIDP_STATUS_INVALID_REPORT_TYPE | 指定したレポートの種類が無効です。 |
HIDP_STATUS_INVALID_REPORT_LENGTH | 指定されたレポートの長さが無効です。 |
HIDP_STATUS_BAD_LOG_PHY_VALUES | コレクションから無効な論理値または物理値が返されました。 コレクションによって返される値を抽出するには、HidP_GetUsageValueを呼び出します。 |
HIDP_STATUS_NULL | コレクションのスケールされた値の現在の状態が論理最小値より小さいか、または論理最大値より大きく、スケールされた値の状態が null |
HIDP_STATUS_VALUE_OUT_OF_RANGE | コレクションからのスケーリングされた値データの現在の状態が論理最小値より小さいか、または論理最大値より大きい。 |
HIDP_STATUS_USAGE_NOT_FOUND | 指定した使用法、使用状況ページ、またはリンク コレクションは、指定した最上位レベルのコレクションでサポートされているレポートに見つかりません。 |
HIDP_STATUS_INCOMPATIBLE_REPORT_ID | 指定した値は、指定したレポートには含まれませんが、指定した最上位レベルのコレクションでサポートされている別のレポートに含まれています。 |
備考
スケーリングされた値は、感度やデバイスの範囲などの特定のパラメーターに基づいて変更される生 HID データの調整された出力を指します。 この調整により、デバイスの使用目的に関連してデータをより意味のある解釈が可能になります。
HID レポートの解釈方法とスケール値の重要性の詳細については、「HID レポートの解釈を参照してください。
PreparesedData、UsageValue、および Report で提供される呼び出し元割り当てバッファーは、非ページ プールから割り当てる必要があります。
ユーザー モード アプリケーションとカーネル モード ドライバーは、HidP_GetUsageValueArray を使用して、使用量値配列のデータ抽出する必要があります。
ルーチンが状態HIDP_STATUS_BAD_LOG_PHY_VALUESを返す場合、アプリケーションまたはドライバーは HidP_GetUsageValue を呼び出して生の使用状況データを抽出できます。
詳細については、「HID コレクションの」を参照してください。
必要条件
要件 | 価値 |
---|---|
サポートされる最小クライアント | Windows 2000 以降のバージョンの Windows で使用できます。 |
ターゲット プラットフォーム の |
万国 |
ヘッダー | hidpi.h (Hidpi.h を含む) |
ライブラリ | Hidparse.lib |
IRQL | <= DISPATCH_LEVEL |
関連項目
- HID 使用法 を
する - 準備済みデータ
- 最上位レベルのコレクション を
する - HID レポート の解釈
- HID コレクション
- HidP_GetUsageValue
- HidP_GetUsageValueArray
- _HIDP_PREPARSED_DATA