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
指向变量的指针,该变量接收指向 USB 管道对象的 IWDFUsbTargetPipe 接口的指针,该对象的索引由 PipeIndex 指定。
返回值
RetrieveUsbPipeObject 返回以下值之一:
返回代码 | 说明 |
---|---|
|
RetrieveUsbPipeObject 已成功检索 USB 管道对象。 |
|
RetrieveUsbPipeObject 遇到分配失败。 |
|
此值对应于 WinUsb API 返回的错误代码。 |
注解
UMDF 驱动程序可以调用 RetrieveUsbPipeObject 方法检索的 IWDFUsbTargetPipe 接口的方法,以获取管道的类型和其他信息。
示例
有关如何使用RetrieveUsbPipeObject 方法的代码示例,请参阅 IWDFUsbInterface::GetNumEndPoints。
要求
要求 | 值 |
---|---|
结束支持 | 在 UMDF 2.0 及更高版本中不可用。 |
目标平台 | 桌面 |
最低 UMDF 版本 | 1.5 |
标头 | wudfusb.h (包括 Wudfusb.h) |
DLL | WUDFx.dll |