HidD_SetFeature関数 (hidsdi.h)
HidD_SetFeature ルーチンは、機能レポートを最上位のコレクションに送信します。
構文
BOOLEAN HidD_SetFeature(
[in] HANDLE HidDeviceObject,
[in] PVOID ReportBuffer,
[in] ULONG ReportBufferLength
);
パラメーター
[in] HidDeviceObject
最上位のコレクションに対する開いているハンドル。
[in] ReportBuffer
呼び出し元が HID レポート ID を指定するために使用する、呼び出し元によって割り当てられた機能レポート バッファーへのポインター。
このパラメーターの詳細については、「 解説 」セクションを参照してください。
[in] ReportBufferLength
レポート バッファーのサイズ (バイト単位)。 レポート バッファーは、機能レポートを保持するのに十分な大きさに加えて、0 以外のレポート ID を指定する 1 つの追加バイトが必要です。 レポート ID を使用しない場合、ID 値は 0 です。
戻り値
HidD_SetFeature成功すると、TRUE が返されます。それ以外の場合は、FALSE を返します。 GetLastError を使用して、拡張エラー情報を取得します。
注釈
正しい ReportBufferLength は、呼び出しから返される最上位コレクションのHIDP_CAPS構造体の FeatureReportByteLength メンバー HidP_GetCaps指定されます。
HidD_SetFeature ルーチンを呼び出す前に、呼び出し元は次の操作を行う必要があります。
- 最上位のコレクションにレポート ID が含まれている場合、呼び出し元は ReportBuffer パラメーターの最初のバイトを 0 以外のレポート ID に設定する必要があります。
- 最上位のコレクションにレポート ID が含まれていない場合、呼び出し元は ReportBuffer パラメーターの最初のバイトを 0 に設定する必要があります。
- 機能レポートは ReportBuffer パラメーターによって参照されます。 レポート ID に応じて、呼び出し元は次のいずれかの関数を呼び出してレポートを準備します。
HID レポートを準備して 最上位のコレクションに送信する方法の例については、 HClient サンプル アプリケーションを参照してください。
HidD_SetFeatureを呼び出すことができるのは、ユーザー モード アプリケーションだけです。 カーネル モード ドライバーは、 IOCTL_HID_SET_FEATURE 要求を使用できます。
要件
要件 | 値 |
---|---|
サポートされている最小のクライアント | Windows 2000 以降のバージョンの Windows で使用できます。 |
対象プラットフォーム | ユニバーサル |
Header | hidsdi.h (Hidsdi.h を含む) |
Library | Hid.lib |
[DLL] | Hid.dll |