Función WdfUsbTargetPipeResetSynchronously (wdfusb.h)

[Se aplica a KMDF y UMDF]

El método WdfUsbTargetPipeResetSynchronousmente compila una solicitud de restablecimiento y la envía de forma sincrónica a una canalización USB especificada.

Sintaxis

NTSTATUS WdfUsbTargetPipeResetSynchronously(
  [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

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

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 WdfUsbTargetPipeResetSynchronously para enviar una solicitud de restablecimiento USB de forma sincrónica. Para enviar estas solicitudes de forma asincrónica, use WdfUsbTargetPipeFormatRequestForReset, seguido de WdfRequestSend.

Antes de que el marco restablezca la canalización USB del destino de E/S, cancela todas las solicitudes de E/S que permanecen en la cola del destino de E/S. El controlador no debe enviar solicitudes de E/S adicionales al destino de E/S hasta que WdfUsbTargetPipeResetSynchronously devuelve.

El controlador debe llamar a WdfIoTargetStop antes de llamar a WdfUsbTargetPipeResetSynchronously. Después de WdfUsbTargetPipeResetSynchronously devuelve, el controlador puede llamar a WdfIoTargetStart.

Cuando un controlador llama a WdfUsbTargetPipeResetSynchronously, el marco envía una solicitud de URB_FUNCTION_RESET_PIPE al destino de E/S. Para obtener más información sobre cómo restablecer una canalización USB, consulte la especificación USB.

El método WdfUsbTargetPipeResetSynchronously no devuelve hasta que se haya completado la solicitud, a menos que el controlador suministre un valor de tiempo de espera en la estructura WDF_REQUEST_SEND_OPTIONS a la que apunta el 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 WdfUsbTargetPipeResetSynchronously 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.

NTSTATUS  status;

status = WdfUsbTargetPipeResetSynchronously(
                                            Pipe, 
                                            WDF_NO_HANDLE,
                                            NULL
                                            );