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 方法。 WdfUsbTargetPipeWdmGetPipeHandle 返回的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) |
库 | Wdf01000.sys(请参阅框架库版本控制。 |
IRQL | <=DISPATCH_LEVEL |
DDI 符合性规则 | DriverCreate(kmdf),KmdfIrql(kmdf),KmdfIrql2(kmdf),KmdfIrqlExplicit(kmdf)、UsbKmdfIrql(kmdf)、UsbKmdfIrql2(kmdf)、UsbKmdfIrqlExplicit(kmdf) |