Función WdfUsbTargetPipeWdmGetPipeHandle (wdfusb.h)
[Solo se aplica a KMDF]
El método WdfUsbTargetPipeWdmGetPipeHandle devuelve el identificador con tipo USBD_PIPE_HANDLE asociado a un objeto de canalización de marco especificado.
Sintaxis
USBD_PIPE_HANDLE WdfUsbTargetPipeWdmGetPipeHandle(
[in] WDFUSBPIPE UsbPipe
);
Parámetros
[in] UsbPipe
Identificador de un objeto de canalización de marco que se obtuvo mediante una llamada a WdfUsbInterfaceGetConfiguredPipe.
Valor devuelto
WdfUsbTargetPipeWdmGetPipeHandle devuelve un identificador con tipo USBD_PIPE_HANDLE.
Se produce una comprobación de errores si el controlador proporciona un identificador de objeto no válido.
Comentarios
Un controlador basado en marcos debe obtener un identificador con tipo USBD_PIPE_HANDLE solo si crea un URB que requiere un identificador de canalización.
El controlador puede llamar al método WdfUsbTargetPipeWdmGetPipeHandle después de llamar a WdfUsbTargetDeviceSelectConfig. El identificador con tipo USBD_PIPE_HANDLE que devuelve WdfUsbTargetPipeWdmGetPipeHandle es válido hasta que el controlador llame a WdfUsbTargetDeviceSelectConfig de nuevo, el controlador llama a WdfUsbInterfaceSelectSetting o se elimina el objeto de canalización del marco. Si el controlador proporciona una función EvtCleanupCallback para el objeto de canalización del marco y si el objeto se elimina antes de que el controlador llame a WdfUsbTargetDeviceSelectConfig de nuevo o llama a WdfUsbInterfaceSelectSetting, el identificador es válido hasta que la función EvtCleanupCallback del objeto devuelve.
Para obtener más información sobre el método WdfUsbTargetPipeWdmGetPipeHandle y los destinos de E/S USB, consulte Destinos de E/S USB.
Ejemplos
En el ejemplo de código siguiente se obtiene el identificador con tipo USBD_PIPE_HANDLE para una canalización especificada.
USBD_PIPE_HANDLE usbdPipeHandle;
usbdPipeHandle = WdfUsbTargetPipeWdmGetPipeHandle(UsbPipe);
Requisitos
| Requisito | Value |
|---|---|
| Plataforma de destino | Universal |
| Versión mínima de KMDF | 1.0 |
| Encabezado | wdfusb.h (incluya Wdfusb.h) |
| Library | Wdf01000.sys (consulte Control de versiones de la biblioteca de marcos). |
| IRQL | <=DISPATCH_LEVEL |
| Reglas de cumplimiento de DDI | DriverCreate(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf), UsbKmdfIrql(kmdf), UsbKmdfIrql2(kmdf), UsbKmdfIrqlExplicit(kmdf) |