HidP_UnsetUsages 関数 (hidpi.h)

[アーティクル]
08/07/2023

HidP_UnsetUsages ルーチンは、HID レポートで指定された HID コントロールボタンの使用法を OFF (ゼロ) に設定します。

構文

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

Report にあるレポートの種類を示す HIDP_REPORT_TYPE 列挙子の値を指定 します。

[in] UsagePage

UsageList で指定された使用法の使用状況ページを指定します。

[in, optional] LinkCollection

使用法を含むリンクコレクションを指定します。 LinkCollection が 0 以外の場合、ルーチンは、このリンクコレクション内に存在する場合にのみ使用法を設定します。 LinkCollection が 0 の場合、ルーチンは、PreparsedData に関連付けられている最上位のコレクションで見つかる各使用法の最初の使用法を設定します。

[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 は、入力パラメーターのいずれかが無効な場合に、次のいずれかの状態値を返します。

リターンコード	説明
HIDP_STATUS_INVALID_PREPARSED_DATA	PreparsedData で指定された準備済みデータが無効です。
HIDP_STATUS_INVALID_REPORT_LENGTH	レポートの長さが無効です。
HIDP_STATUS_INVALID_REPORT_TYPE	レポートの種類が無効です。
HIDP_STATUS_REPORT_DOES_NOT_EXIST	コレクションには、指定した型のレポートが含まれていません。

HidP_UnsetUsagesでは、UsageList の使用法の 1 つを OFF に設定できなかった場合、次のいずれかの状態値が返されます。

リターンコード	説明
HIDP_STATUS_BUTTON_NOT_PRESSED	使用量は既に OFF に設定されています。
HIDP_STATUS_INCOMPATIBLE_REPORT_ID	使用状況は指定したレポートには含まれませんが、指定した種類の別のレポートに含まれています。
HIDP_STATUS_USAGE_NOT_FOUND	ルーチンは、指定された型のレポートで使用状況を見つけることができませんでした。

注釈

HidP_UnsetUsagesは、UsageLength を次のように設定します。

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

要件

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