IWDFUsbTargetDevice::RetrieveDeviceInformation メソッド (wudfusb.h)

  • [アーティクル]

[警告: UMDF 2 は UMDF の最新バージョンであり、UMDF 1 よりも優先されます。 すべての新しい UMDF ドライバーは、UMDF 2 を使用して記述する必要があります。 UMDF 1 には新機能が追加されておらず、新しいバージョンのWindows 10では UMDF 1 のサポートが制限されています。 ユニバーサル Windows ドライバーでは UMDF 2 を使用する必要があります。 詳細については、「UMDF を使用したはじめに」を参照してください。

RetrieveDeviceInformation メソッドは、指定した種類のデバイス情報を取得します。

構文

HRESULT RetrieveDeviceInformation(
  [in]      ULONG InformationType,
  [in, out] ULONG *BufferLength,
  [out]     PVOID Buffer
);

パラメーター

[in] InformationType

UMDF ドライバーがデバイスに関して要求する情報の種類。

[in, out] BufferLength

入力時に 、RetrieveDeviceInformation が Buffer に提供するバッファーのサイズをバイト単位で格納する変数へのポインター。 出力時に、このパラメーターには 、Buffer に必要な RetrieveDeviceInformation のサイズが含 まれます。

[out] Buffer

デバイス情報を含むバッファーを受け取るポインター。

戻り値

RetrieveDeviceInformation は、次のいずれかの値を返します。

リターン コード 説明
S_ok

RetrieveDeviceInformation がデバイス情報を正常に取得しました。
E_OUTOFMEMORY

RetrieveDeviceInformation で割り当てエラーが発生しました。
Winerror.h で定義されているエラー コード
 この値は、WinUsb API から返されたエラー コードに対応します。

注釈

UMDF ドライバーが InformationType パラメーターに渡すことができる有効な情報の種類については、 WinUsb_QueryDeviceInformation 関数を参照してください。

InformationType がDEVICE_SPEED (0x01) の場合、正常に戻ると、Buffer はデバイスの動作速度を示します。 0x03は高速以上を示します。0x01は、全速度以下を示します。

RetrieveDeviceInformation メソッドは、UMDF 要求を生成し、その要求を I/O ターゲットに同期的に送信します。

例

RetrieveDeviceInformation メソッドの使用方法のコード例については、「IWDFUsbTargetPipe::SetPipePolicy」を参照してください。

要件

要件 値
サポート終了 UMDF 2.0 以降では使用できません。
対象プラットフォーム デスクトップ
最小 UMDF バージョン 1.5
Header wudfusb.h (Wudfusb.h を含む)
[DLL] WUDFx.dll

こちらもご覧ください

IWDFUsbTargetDevice

WinUsb_QueryDeviceInformation