Función WdfUsbTargetPipeFormatRequestForAbort (wdfusb.h)

[Se aplica a KMDF y UMDF]

El método WdfUsbTargetPipeFormatRequestForAbort crea una solicitud de anulación para una canalización USB especificada, pero no envía la solicitud.

Sintaxis

NTSTATUS WdfUsbTargetPipeFormatRequestForAbort(
  [in] WDFUSBPIPE Pipe,
  [in] WDFREQUEST Request
);

Parámetros

[in] Pipe

Identificador de un objeto de canalización de marco que se obtuvo mediante una llamada a WdfUsbInterfaceGetConfiguredPipe.

[in] Request

Identificador de un objeto de solicitud de marco. Para obtener más información, vea la sección Comentarios que se muestra más adelante.

Valor devuelto

WdfUsbTargetPipeFormatRequestForAbort 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 valores siguientes:

Este método también podría devolver otros valores NTSTATUS.

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

Comentarios

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

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 WdfRequestSend, el marco envía una solicitud de URB_FUNCTION_ABORT_PIPE al destino de E/S. Para obtener más información sobre cómo cancelar las operaciones en una canalización USB (también denominada "anulación de una canalización"), consulte la especificación USB.

Puede reenviar una solicitud de E/S que el controlador recibió en una cola de E/S o 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 Request del método WdfUsbTargetPipeFormatRequestForAbort.

Para crear una nueva solicitud de E/S, llame a WdfRequestCreate para prealcalizar un objeto de solicitud. Proporcione el identificador de solicitud para el parámetro Request del método Request del método WdfUsbTargetPipeFormatRequestForAbort. Puede reutilizar el objeto de solicitud llamando a WdfRequestReuse. La función de devolución de llamada EvtDriverDeviceAdd del controlador puede asignar previamente objetos de solicitud para un dispositivo.

Después de llamar a WdfUsbTargetPipeFormatRequestForAbort para dar formato a una solicitud de E/S, el controlador debe llamar a WdfRequestSend para enviar la solicitud (ya sea de forma sincrónica o asincrónica) a un destino de E/S.

Varias llamadas a WdfUsbTargetPipeFormatRequestForAbort que usan la misma solicitud no provocan asignaciones de recursos adicionales. Por lo tanto, para reducir la posibilidad de que WdfRequestCreate devuelva STATUS_INSUFFICIENT_RESOURCES, la función de devolución de llamada EvtDriverDeviceAdd del controlador puede llamar a WdfRequestCreate para asignar previamente uno o varios objetos de solicitud para un dispositivo. Posteriormente, el controlador puede reutilizar (llamar a WdfRequestReuse), formatear (llamar a WdfUsbTargetPipeFormatRequestForAbort) y volver a enviar (llamada A WdfRequestSend) cada objeto de solicitud sin arriesgar un valor devuelto STATUS_INSUFFICIENT_RESOURCES desde una llamada posterior a WdfRequestCreate. Todas las llamadas posteriores a WdfUsbTargetPipeFormatRequestForAbort para el objeto de solicitud reutilizado devolverán STATUS_SUCCESS, si los valores de parámetro no cambian. (Si el controlador no llama al mismo método de formato de solicitud cada vez, se pueden asignar recursos adicionales).

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 WdfUsbTargetPipeFormatRequestForAbort y los destinos de E/S USB, consulte Destinos de E/S USB.

Ejemplos

En el ejemplo de código siguiente se da formato a una solicitud de anulación de una canalización USB, se registra una función de devolución de llamada CompletionRoutine y se envía la solicitud.

status = WdfUsbTargetPipeFormatRequestForAbort(
                                               pipe,
                                               Request
                                               );
if (!NT_SUCCESS(status)) {
    goto Exit;
}

WdfRequestSetCompletionRoutine(
                               Request,
                               AbortCompletionRoutine,
                               pipe
                               );

if (WdfRequestSend(
                   Request,
                   WdfUsbTargetPipeGetIoTarget(pipe),
                   WDF_NO_SEND_OPTIONS
                   ) == FALSE) {
    status = WdfRequestGetStatus(Request);
    goto Exit;
}
Exit:
if (!NT_SUCCESS(status)) {
    WdfRequestCompleteWithInformation(
                                      Request,
                                      status,
                                      0
                                      );
}
return;

Requisitos

Consulte también

WdfUsbInterfaceGetConfiguredPipe