WdfUsbTargetPipeFormatRequestForReset-Funktion (wdfusb.h)

[Gilt für KMDF und UMDF]

Die WdfUsbTargetPipeFormatRequestForReset-Methode erstellt eine Zurücksetzungsanforderung für eine angegebene USB-Pipe, sendet die Anforderung jedoch nicht.

Syntax

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

Parameter

[in] Pipe

Ein Handle für ein Framework-Pipeobjekt, das durch Aufrufen von WdfUsbInterfaceGetConfiguredPipe abgerufen wurde.

[in] Request

Ein Handle für ein Frameworkanforderungsobjekt. Weitere Informationen finden Sie im folgenden Abschnitt "Hinweise".

Rückgabewert

WdfUsbTargetPipeFormatRequestForReset gibt den Abschluss des USB-E/A-Ziels status Wert zurück, wenn der Vorgang erfolgreich ist. Andernfalls kann diese Methode einen der folgenden Werte zurückgeben:

Diese Methode kann auch andere NTSTATUS-Werte zurückgeben.

Eine Fehlerüberprüfung tritt auf, wenn der Treiber ein ungültiges Objekthandle bereitstellt.

Hinweise

Verwenden Sie WdfUsbTargetPipeFormatRequestForReset gefolgt von WdfRequestSend, um eine USB-Zurücksetzungsanforderung entweder synchron oder asynchron zu senden. Alternativ können Sie die WdfUsbTargetPipeResetSynchronously-Methode verwenden, um eine Anforderung synchron zu senden.

Bevor der Treiber WdfRequestSend aufruft, muss er WdfIoTargetStop aufrufen und alle E/A-Anforderungen abschließen oder abbrechen , die er an das E/A-Ziel gesendet hat. Der Treiber darf keine zusätzlichen E/A-Anforderungen an das E/A-Ziel senden, bis die Zurücksetzungsanforderung abgeschlossen ist.

Wenn ein Treiber WdfRequestSend aufruft, sendet das Framework eine URB_FUNCTION_RESET_PIPE Anforderung an das E/A-Ziel. Weitere Informationen zum Zurücksetzen einer USB-Pipe finden Sie in der USB-Spezifikation.

Sie können eine E/A-Anforderung weiterleiten, die Ihr Treiber in einer E/A-Warteschlange empfangen hat, oder Sie können eine neue Anforderung erstellen und senden.

Um eine E/A-Anforderung weiterzuleiten, die Ihr Treiber in einer E/A-Warteschlange empfangen hat, geben Sie das Handle der empfangenen Anforderung für den Request-Parameter der WdfUsbTargetPipeFormatRequestForReset-Methode an.

Um eine neue E/A-Anforderung zu erstellen, rufen Sie WdfRequestCreate auf , um ein Anforderungsobjekt vorab zuzuspeichern. Geben Sie das Anforderungshandle für den Request-Parameter der WdfUsbTargetPipeFormatRequestForReset-Methode an. Sie können das Anforderungsobjekt wiederverwenden, indem Sie WdfRequestReuse aufrufen. Die Rückruffunktion EvtDriverDeviceAdd Ihres Treibers kann Anforderungsobjekte für ein Gerät vorab zuweisungen.

Nach dem Aufrufen von WdfUsbTargetPipeFormatRequestForReset zum Formatieren einer E/A-Anforderung muss der Treiber WdfRequestSend aufrufen, um die Anforderung (synchron oder asynchron) an ein E/A-Ziel zu senden.

Mehrere Aufrufe von WdfUsbTargetPipeFormatRequestForReset , die dieselbe Anforderung verwenden, verursachen keine zusätzlichen Ressourcenzuordnungen. Aus diesem Grund kann die EvtDriverDeviceAdd-Rückruffunktion Ihres Treibers WdfRequestCreate aufrufen, um die Chance zu verringern, dass WdfRequestCreate zurückgegeben STATUS_INSUFFICIENT_RESOURCES wird, um ein oder mehrere Anforderungsobjekte für ein Gerät vorab zu verwenden. Der Treiber kann jedes Anforderungsobjekt anschließend wiederverwenden ( WdfRequestReuse aufrufen), neu formatieren ( WdfUsbTargetPipeFormatRequestForReset aufrufen) und jedes Anforderungsobjekt erneut senden (WdfRequestSend aufrufen), ohne einen STATUS_INSUFFICIENT_RESOURCES Rückgabewert aus einem späteren Aufruf von WdfRequestCreate zu riskieren. Alle nachfolgenden Aufrufe von WdfUsbTargetPipeFormatRequestForReset für das wiederverwendete Anforderungsobjekt geben STATUS_SUCCESS zurück, wenn sich die Parameterwerte nicht ändern. (Wenn der Treiber nicht jedes Mal dieselbe Methode zur Anforderungsformatierung aufruft, werden möglicherweise zusätzliche Ressourcen zugeordnet.)

Informationen zum Abrufen status Informationen nach Abschluss einer E/A-Anforderung finden Sie unter Abrufen von Abschlussinformationen.

Weitere Informationen zur WdfUsbTargetPipeFormatRequestForReset-Methode und USB-E/A-Zielen finden Sie unter USB-E/A-Ziele.

Beispiele

Im folgenden Codebeispiel wird eine Zurücksetzungsanforderung für eine USB-Pipe formatiert, eine CompletionRoutine-Rückruffunktion registriert und die Anforderung gesendet.

status = WdfUsbTargetPipeFormatRequestForReset(
                                               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;

Anforderungen

Weitere Informationen

WdfRequestSend

WdfUsbInterfaceGetConfiguredPipe