HidP_GetUsageValue関数 (hidpi.h)
HidP_GetUsageValue ルーチンは、HID レポートの選択条件に一致する HID コントロール値に関連付けられているデータを抽出します。
構文
NTSTATUS HidP_GetUsageValue(
[in] HIDP_REPORT_TYPE ReportType,
[in] USAGE UsagePage,
[in] USHORT LinkCollection,
[in] USAGE Usage,
[out] PULONG UsageValue,
[in] PHIDP_PREPARSED_DATA PreparsedData,
[in] PCHAR Report,
[in] ULONG ReportLength
);
パラメーター
[in] ReportType
レポートの種類を識別する HIDP_REPORT_TYPE 列挙子の値を指定します。
[in] UsagePage
値の 使用状況ページを指定します。
[in] LinkCollection
値を含む リンク コレクション を指定します。 LinkCollection が 0 以外の場合、ルーチンはこのリンク コレクション内の使用法のみを検索します。それ以外の場合、LinkCollection が 0 の場合、ルーチンは、PreparesedDataに関連付けられている 最上位コレクション内の使用状況を検索します。
[in] Usage
値の使用法を指定します。
[out] UsageValue
ルーチンが値データを返すバッファーへのポインター。
[in] PreparsedData
最上位レベルのコレクションの 準備されたデータへのポインター。
[in] Report
値を含むレポートへのポインター。
[in] ReportLength
Reportにあるレポートの長さをバイト単位で指定します。
戻り値
HidP_GetUsageValue は、次のいずれかの状態値を返します。
| リターン コード | 形容 |
|---|---|
|
ルーチンは値データを正常に返しました。 |
|
レポートの長さが無効です。 |
|
指定したレポートの種類が無効です。 |
|
コレクションには、指定した種類のレポート内の指定した使用状況ページの値が含まれていますが、指定したレポートにそのような使用法はありません。 |
|
準備されたデータが無効です。 |
|
コレクションには、指定したレポートの種類のレポート内の指定した使用状況ページの値が含まれていません。 |
備考
HidP_GetUsageValue は、値に署名したりスケーリングしたりしません。 符号付き値を抽出するには、HidP_GetScaledUsageValueを使用します。 符号ビットを手動で割り当てるには、値の HIDP_VALUE_CAPS 構造内の情報から符号ビットの位置を決定できます。
HidP_GetUsageValue は、レポート数が 1 の使用状況の使用状況値を抽出するように設計されています。 指定した使用状況のレポート数が 1 より大きい場合、使用状況は 使用状況値配列の一部です。 HidP_GetUsageValue は、使用値配列内の最初のデータ項目のみを返します。 使用値配列内のすべてのデータ項目を抽出するには、HidP_GetUsageValueArrayを使用します。
詳細については、「HID コレクションの」を参照してください。
必要条件
| 要件 | 価値 |
|---|---|
| サポートされる最小クライアント | Windows 2000 以降のバージョンの Windows で使用できます。 |
| ターゲット プラットフォーム の | 万国 |
| ヘッダー | hidpi.h (Hidpi.h を含む) |
| ライブラリ | Hidparse.lib |
| IRQL | <= DISPATCH_LEVEL |