Función WdfUsbTargetPipeAbortSynchronously (wdfusb.h)

Artículo
07/16/2024

[Se aplica a KMDF y UMDF]

El método WdfUsbTargetPipeAbortSynchronousmente compila una solicitud de anulación y la envía sincrónicamente a una canalización USB especificada.

Sintaxis

NTSTATUS WdfUsbTargetPipeAbortSynchronously(
  [in]           WDFUSBPIPE                Pipe,
  [in, optional] WDFREQUEST                Request,
  [in, optional] PWDF_REQUEST_SEND_OPTIONS RequestOptions
);

Parámetros

[in] Pipe

Identificador de un objeto de canalización de marco que se obtuvo llamando a WdfUsbInterfaceGetConfiguredPipe.

[in, optional] Request

Identificador de un objeto de solicitud de marco. Este parámetro es opcional y se puede NULL. Para obtener más información, vea la siguiente sección Comentarios.

[in, optional] RequestOptions

Puntero a una estructura de WDF_REQUEST_SEND_OPTIONS asignada por el autor de la llamada que especifica las opciones de la solicitud. Este puntero es opcional y se puede NULL. Para obtener más información, vea la siguiente sección Comentarios.

Valor devuelto

WdfUsbTargetPipeAbortSynchronously devuelve el valor de estado de finalización del destino de E/S si la operación se realiza correctamente. De lo contrario, este método puede devolver uno de los siguientes valores:

Código devuelto	Descripción
STATUS_INFO_LENGTH_MISMATCH	El tamaño de la estructura de WDF_REQUEST_SEND_OPTIONS que especificó el parámetro RequestOptions era incorrecto.
STATUS_INVALID_PARAMETER	Se detectó un identificador no válido.
STATUS_INSUFFICIENT_RESOURCES	Memoria insuficiente disponible.
STATUS_INVALID_DEVICE_REQUEST	El IRQL del autor de la llamada no se PASSIVE_LEVEL o la solicitud de E/S especificada ya estaba en cola en un destino de E/S.
STATUS_IO_TIMEOUT	El controlador proporcionó un valor de tiempo de espera y la solicitud no se completó dentro del tiempo asignado.

Este método también puede devolver otros valores de NTSTATUS.

Se produce una comprobación de errores si el controlador proporciona un identificador de objeto no válido.

Observaciones

Use el método WdfUsbTargetPipeAbortSynchronously para enviar una solicitud de anulación USB de forma sincrónica. Para enviar estas solicitudes de forma asincrónica, use WdfUsbTargetPipeFormatRequestForAbort, seguido de WdfRequestSend.

Una solicitud de anulación USB hace que el destino de E/S del controlador cancele todas las solicitudes de E/S que se han enviado a una canalización. Cuando un controlador llama a WdfUsbTargetPipeAbortSynchronously, el marco envía una solicitud de URB_FUNCTION_ABORT_PIPE al destino de E/S. Para obtener más información sobre la cancelación de operaciones en una canalización USB (también denominada "anulación de una canalización"), consulte la especificación USB.

El método WdfUsbTargetPipeAbortSynchronously no devuelve hasta que se haya completado la solicitud, a menos que el controlador especifique un valor de tiempo de espera en la estructura WDF_REQUEST_SEND_OPTIONS del parámetro RequestOptions o a menos que se detecte un error.

Puede reenviar una solicitud de E/S que el controlador recibió en una cola de E/S, o bien puede crear y enviar una nueva solicitud.

Para reenviar una solicitud de E/S que el controlador recibió en una cola de E/S, especifique el identificador de la solicitud recibida para el parámetro WdfUsbTargetPipeAbortSynchronously del método Request.

Para crear y enviar una nueva solicitud, proporcione un identificador de solicitud NULL para el parámetro request de o cree un nuevo objeto de solicitud y proporcione su identificador:

Si proporciona un identificador de solicitud NULL, el marco usa un objeto de solicitud interno. Esta técnica es sencilla de usar, pero el controlador no puede cancelar la solicitud.
Si llama a WdfRequestCreate para crear uno o varios objetos de solicitud, puede reutilizar estos objetos de solicitud llamando a WdfRequestReuse. Esta técnica permite al controlador EvtDriverDeviceAdd función de devolución de llamada para asignar previamente objetos de solicitud para un dispositivo. Además, otro subproceso de controlador puede llamar a WdfRequestCancelSentRequest para cancelar la solicitud, si es necesario.

El controlador puede especificar un parámetro requestOptions que no sea NULLNULL o un parámetro request null NULL. Por ejemplo, puede usar el parámetro RequestOptions para especificar un valor de tiempo de espera.

Para obtener información sobre cómo obtener información de estado una vez completada una solicitud de E/S, vea Obtener información de finalización.

Para obtener más información sobre el método WdfUsbTargetPipeAbortSynchronously y los destinos de E/S USB, consulte destinos de E/S USB.

Ejemplos

En el ejemplo de código siguiente se envían solicitudes de anulación a todas las canalizaciones configuradas para la interfaz de un dispositivo USB.

UCHAR  i;
ULONG  count;
NTSTATUS  status;
PDEVICE_CONTEXT  pDevContext;

pDevContext = GetDeviceContext(Device);

count = WdfUsbInterfaceGetNumConfiguredPipes(
                                             pDevContext->UsbInterface
                                             );

for (i = 0; i < count; i++) {
    WDFUSBPIPE pipe;

    pipe = WdfUsbInterfaceGetConfiguredPipe(
                                            pDevContext->UsbInterface,
                                            i,
                                            NULL
                                            );
    status = WdfUsbTargetPipeAbortSynchronously(
                                                pipe,
                                                WDF_NO_HANDLE,
                                                NULL
                                                );
    if (!NT_SUCCESS(status)) {
        break;
    }
}

Requisitos

Requisito	Valor
de la plataforma de destino de	Universal
versión mínima de KMDF	1.0
versión mínima de UMDF	2.0
encabezado de	wdfusb.h (incluya Wdfusb.h)
biblioteca de	Wdf01000.sys (KMDF); WUDFx02000.dll (UMDF)
irQL	PASSIVE_LEVEL
reglas de cumplimiento de DDI	DriverCreate(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf), RequestForUrbXrb(kmdf), UsbKmdfIrql(kmdf), UsbKmdfIrql2(kmdf), UsbKmdfIrqlExplicit(kmdf)

Consulte también

WdfRequestCancelSentRequest

WdfUsbTargetPipeResetSynchronously

Compartir a través de