次の方法で共有


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
ヘッダー wudfusb.h (Wudfusb.h を含む)
DLL WUDFx.dll

関連項目

IWDFUsbInterface

IWDFUsbTargetPipe