HidP_UnsetUsages関数 (hidpi.h)
HidP_UnsetUsages ルーチンは、HID レポートで OFF (ゼロ) 使用法を、指定された HID コントロール ボタンを設定します。
構文
NTSTATUS HidP_UnsetUsages(
[in] HIDP_REPORT_TYPE ReportType,
[in] USAGE UsagePage,
[in, optional] USHORT LinkCollection,
[in, out] PUSAGE UsageList,
[in, out] PULONG UsageLength,
[in] PHIDP_PREPARSED_DATA PreparsedData,
[in] PCHAR Report,
[in] ULONG ReportLength
);
パラメーター
[in] ReportType
レポート にあるレポートの種類を示す HIDP_REPORT_TYPE 列挙子の値指定します。
[in] UsagePage
UsageList で指定された使用状況使用ページを指定します。
[in, optional] LinkCollection
使用法を含む リンク コレクション を指定します。 LinkCollection が 0 以外の場合、ルーチンは、このリンク コレクション内に存在する場合にのみ使用法を設定します。 LinkCollection が 0 の場合、ルーチンは、PreparesedDataに関連付けられている 最上位のコレクションで見つかる各使用法の最初の使用法を設定します。
[in, out] UsageList
OFF に設定する使用法の配列へのポインター。
[in, out] UsageLength
入力時に、UsageList の使用量指定します。 出力値の詳細については、「解説」セクションを参照してください。
[in] PreparsedData
レポート にあるレポートに関連付けられている最上位のコレクションの 準備データポインター。
[in] Report
レポートへのポインター。
[in] ReportLength
Reportにあるレポートのサイズ (バイト単位) を指定します。これは、コレクションの HIDP_CAPS 構造体で返 HidP_GetCaps 指定したレポートの種類のレポートの長さと同じである必要があります。
戻り値
HidP_UnsetUsages は、UsageList 内のすべての使用状況を OFF に正常に設定した場合にHIDP_STATUS_SUCCESS返します。
入力パラメーターのいずれかが無効な場合、HidP_UnsetUsages は次のいずれかの状態値を返します。
| リターン コード | 形容 |
|---|---|
|
PreparesedData で指定された準備済みデータが無効です。 |
|
レポートの長さが無効です。 |
|
レポートの種類が無効です。 |
|
コレクションに、指定した型のレポートが含まれていません。 |
HidP_UnsetUsages は、UsageList でいずれかの使用法を OFF に設定できなかった場合、次のいずれかの状態値返します。
| リターン コード | 形容 |
|---|---|
|
使用量は既に OFF に設定されています。 |
|
使用状況は、指定したレポートには含まれませんが、指定した種類の別のレポートに含まれています。 |
|
ルーチンは、指定された型のレポートで使用状況を検出しませんでした。 |
備考
HidP_UnsetUsages は、UsageLength 次のように設定します。
詳細については、「HID コレクションの」を参照してください。
必要条件
| 要件 | 価値 |
|---|---|
| サポートされる最小クライアント | Windows 2000 以降のバージョンの Windows で使用できます。 |
| ターゲット プラットフォーム の | 万国 |
| ヘッダー | hidpi.h (Hidpi.h を含む) |
| ライブラリ | Hidparse.lib |
| IRQL | <=DISPATCH_LEVEL |