HidP_SetUsages関数 (hidpi.h)

[アーティクル]
02/26/2024

HidP_SetUsages ルーチンは、HID レポートで指定された HID コントロールボタン ON (1) を設定します。

構文

NTSTATUS HidP_SetUsages(
  [in]      HIDP_REPORT_TYPE     ReportType,
  [in]      USAGE                UsagePage,
  [in]      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] LinkCollection

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

[in, out] UsageList

使用法の配列へのポインター。

[in, out] UsageLength

入力時に UsageList の使用量の数を指定します。出力値の詳細については、「解説」セクションを参照してください。

[in] PreparsedData

レポートにあるレポートに関連付けられている最上位のコレクションの準備済みデータへのポインター。

[in] Report

レポートへのポインター。

[in] ReportLength

Report にあるレポートのサイズをバイト単位で指定します。これは、コレクションのHIDP_CAPS構造体で返HidP_GetCaps指定したレポートの種類のレポートの長さと同じである必要があります。

戻り値

HidP_SetUsages は、次のいずれかの状態値を返します。

リターンコード	説明
HIDP_STATUS_SUCCESS	ルーチンは、使用値を正常に設定しました。
HIDP_STATUS_BUFFER_TOO_SMALL	ボタン配列の使用法は、配列が既に完全に設定されているため、設定できません。
HIDP_STATUS_INVALID_REPORT_LENGTH	レポートの長さが無効です。
HIDP_STATUS_INVALID_REPORT_TYPE	指定したレポートの種類が無効です。
HIDP_STATUS_INCOMPATIBLE_REPORT_ID	使用状況は、指定したレポートには存在しませんが、指定した種類の別のレポートに存在します。
HIDP_STATUS_INVALID_PREPARSED_DATA	準備されたデータが無効です。
HIDP_STATUS_USAGE_NOT_FOUND	指定したレポートの種類のレポートに使用状況が存在しません。

注釈

usageList で使用法HidP_SetUsages設定できない場合、ルーチンは UsageLength を設定できなかった使用量のインデックスに設定し、エラーを示す状態値を返します。

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

要件

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