WdfUsbTargetPipeWdmGetPipeHandle 函数 (wdfusb.h)
[仅适用于 KMDF]
WdfUsbTargetPipeWdmGetPipeHandle 方法返回与指定框架管道对象关联的USBD_PIPE_HANDLE类型句柄。
语法
USBD_PIPE_HANDLE WdfUsbTargetPipeWdmGetPipeHandle(
[in] WDFUSBPIPE UsbPipe
);
参数
[in] UsbPipe
通过调用 WdfUsbInterfaceGetConfiguredPipe 获取的框架管道对象的句柄。
返回值
WdfUsbTargetPipeWdmGetPipeHandle 返回USBD_PIPE_HANDLE类型的句柄。
如果驱动程序提供无效的对象句柄，则会发生 bug 检查。
注解
仅当基于框架的驱动程序创建需要管道句柄的 URB 时，才需要获取USBD_PIPE_HANDLE类型的句柄。
驱动程序可以在调用 WdfUsbTargetDeviceSelectConfig 后调用 WdfUsbTargetPipeWdmGetPipeHandle 方法。 WdfUsbTargetPipeWdmPipeHandle 返回的USBD_PIPE_HANDLE类型句柄在驱动程序再次调用 WdfUsbTargetDeviceSelectConfig、驱动程序调用 WdfUsbInterfaceSelectSetting 或框架管道对象被删除之前有效。 如果驱动程序为框架管道对象提供 EvtCleanupCallback 函数，并且该对象在驱动程序再次调用 WdfUsbTargetDeviceSelectConfig 或调用 WdfUsbInterfaceSelectSetting 之前被删除，则句柄在对象的 EvtCleanupCallback 函数返回之前有效。
有关 WdfUsbTargetPipeWdmGetPipeHandle 方法和 USB I/O 目标的详细信息，请参阅 USB I/O 目标。
示例
下面的代码示例获取指定管道的USBD_PIPE_HANDLE类型句柄。
USBD_PIPE_HANDLE usbdPipeHandle;
usbdPipeHandle = WdfUsbTargetPipeWdmGetPipeHandle(UsbPipe);
要求
| 要求 | 值 |
|---|---|
| 目标平台 | 通用 |
| 最低 KMDF 版本 | 1.0 |
| 标头 | wdfusb.h (包括 Wdfusb.h) |
| Library | Wdf01000.sys (请参阅框架库版本控制.) |
| IRQL | <=DISPATCH_LEVEL |
| DDI 符合性规则 | DriverCreate (kmdf) 、 KmdfIrql (kmdf) 、 KmdfIrql2 (kmdf) 、 KmdfIrqlExplicit (kmdf) ， UsbKmdfIrql (kmdf) 、 UsbKmdfIrql2 (kmdf) 、 UsbKmdfIrqlExplicit (kmdf) |