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_GetUsageValueを呼び出します。 |
|
コレクションのスケールされた値の現在の状態が論理最小値より小さいか、論理最大値より大きく、スケーリングされた値は NULL 状態です。 |
|
コレクションからのスケールされた値データの現在の状態が論理最小値より小さいか、論理最大値より大きい。 |
|
指定した使用法、使用状況ページ、またはリンク コレクションは、指定した最上位コレクションでサポートされているレポートに見つかりません。 |
|
指定した値は、指定したレポートには含まれませんが、指定した最上位コレクションでサポートされている別のレポートに含まれています。 |
注釈
PreparsedData、UsageValue、および Report で提供される呼び出し元割り当てバッファーは、非ページ プールから割り当てる必要があります。
ユーザー モード アプリケーションとカーネル モード ドライバーでは、使用値配列のデータを抽出するためにHidP_GetUsageValueArrayを使用する必要があります。
ルーチンから状態HIDP_STATUS_BAD_LOG_PHY_VALUESが返された場合、アプリケーションまたはドライバーは HidP_GetUsageValue を呼び出して生の使用状況データを抽出できます。
詳細については、「 HID コレクション」を参照してください。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows 2000 以降のバージョンの Windows で使用できます。 |
| 対象プラットフォーム | ユニバーサル |
| Header | hidpi.h (Hidpi.h を含む) |
| Library | Hidparse.lib |
| IRQL | <= DISPATCH_LEVEL |