HidP_InitializeReportForID関数 (hidpi.h)
HidP_InitializeReportForID ルーチンは HID レポートを初期化します。
構文
NTSTATUS HidP_InitializeReportForID(
[in] HIDP_REPORT_TYPE ReportType,
[in] UCHAR ReportID,
[in] PHIDP_PREPARSED_DATA PreparsedData,
[out] PCHAR Report,
[in] ULONG ReportLength
);
パラメーター
[in] ReportType
Report にある HID レポートの種類を示す HIDP_REPORT_TYPE 列挙子を指定 します。
[in] ReportID
レポート ID を指定します。
[in] PreparsedData
レポートにある HID レポートに関連付けられている最上位のコレクションの準備されたデータへのポインター。
[out] Report
HidP_InitializeReportForID初期化する HID レポートを含む呼び出し元によって割り当てられたバッファーへのポインター。
[in] ReportLength
レポートにある HID レポートのサイズをバイト単位で指定 します。 ReportLength は、コレクションのHIDP_CAPS構造体の XxxReportByteLength メンバーによって指定された、指定されたレポートの種類のコレクションのレポート長と等しい必要があります。
戻り値
HidP_InitializeReportForID は、次のいずれかの状態値を返します。
リターン コード | 説明 |
---|---|
|
レポートが正常に初期化されました。 |
|
準備されたデータが無効です。 |
|
指定したレポートの長さが、指定したレポートの種類のコレクションのレポート長と等しくありません。 |
|
レポートの種類が無効です。 |
|
指定されたレポート ID が無効です。 |
注釈
HID レポートを初期化すると、USB HID 標準で定義されているように、すべてのコントロール データが 0 またはコントロールの null 値に設定されます。 (null 値の送受信は、コントロールの現在の値を変更しないことを示します)。
HidP_InitializeReportForID では、次の処理が行われます。
- null 値のないすべてのボタンと値のビットフィールドを 0 に設定します。
- null 値を持つすべてのコントロールのビットフィールドを、対応する null 値に設定します。
要件
要件 | 値 |
---|---|
サポートされている最小のクライアント | Windows 2000 以降のバージョンの Windows で使用できます。 |
対象プラットフォーム | ユニバーサル |
Header | hidpi.h (Hidpi.h を含む) |
Library | Hidparse.lib |
IRQL | <= DISPATCH_LEVEL |