IWDFUsbInterface::RetrieveUsbPipeObject メソッド (wudfusb.h)

  • [アーティクル]

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

RetrieveUsbPipeObject メソッドは、指定されたパイプ インデックスの USB パイプ オブジェクトを取得します。

構文

HRESULT RetrieveUsbPipeObject(
  [in]  UCHAR             PipeIndex,
  [out] IWDFUsbTargetPipe **ppPipe
);

パラメーター

[in] PipeIndex

取得する USB パイプ オブジェクトのインデックス。

[out] ppPipe

インデックスが PipeIndex で指定されている USB パイプ オブジェクトの IWDFUsbTargetPipe インターフェイスへのポインターを受け取る変数へのポインター。

戻り値

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

リターン コード 説明
S_ok

RetrieveUsbPipeObject が USB パイプ オブジェクトを正常に取得しました。
E_OUTOFMEMORY

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

注釈

UMDF ドライバーは、パイプの種類やその他の情報を取得するために RetrieveUsbPipeObject メソッドが取得する IWDFUsbTargetPipe インターフェイスのメソッドを呼び出すことができます。

例

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

要件

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

こちらもご覧ください

IWDFUsbInterface

IWDFUsbTargetPipe