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
レポート にある 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 値のないすべてのボタンと値のビットフィールドをゼロに設定します。
- null 値を持つすべてのコントロールのビットフィールドを、対応する null 値に設定します。
必要条件
要件 | 価値 |
---|---|
サポートされる最小クライアント | Windows 2000 以降のバージョンの Windows で使用できます。 |
ターゲット プラットフォーム の | 万国 |
ヘッダー | hidpi.h (Hidpi.h を含む) |
ライブラリ | Hidparse.lib |
IRQL | <= DISPATCH_LEVEL |