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 會傳回下列其中一個值:

傳回碼 Description
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