IWDFUsbTargetPipe::RetrievePipePolicy-Methode (wudfusb.h)

[Warnung: UMDF 2 ist die neueste Version von UMDF und ersetzt UMDF 1. Alle neuen UMDF-Treiber sollten mit UMDF 2 geschrieben werden. UMDF 1 werden keine neuen Features hinzugefügt, und die Unterstützung für UMDF 1 in neueren Versionen von Windows 10 ist eingeschränkt. Universelle Windows-Treiber müssen UMDF 2 verwenden. Weitere Informationen finden Sie unter Erste Schritte mit UMDF.]

Die RetrievePipePolicy-Methode ruft eine WinUsb-Piperichtlinie ab.

Syntax

HRESULT RetrievePipePolicy(
  [in]      ULONG PolicyType,
  [in, out] ULONG *ValueLength,
  [out]     PVOID Value
);

Parameter

[in] PolicyType

Der Typ der WinUsb-Piperichtlinie, die der UMDF-Treiber anfordert.

[in, out] ValueLength

Ein Zeiger auf eine Variable, die bei der Eingabe die Größe des Puffers in Bytes enthält, den RetrievePipePolicy für Value bereitstellt. In der Ausgabe enthält dieser Parameter die Größe, die RetrievePipePolicy für Value benötigt.

[out] Value

Ein Zeiger, der den Puffer empfängt, der die WinUsb-Piperichtlinie enthält.

Rückgabewert

RetrievePipePolicy gibt einen der folgenden Werte zurück:

Rückgabecode	Beschreibung
S_OK	RetrievePipePolicy hat die WinUsb-Piperichtlinie erfolgreich abgerufen.
E_OUTOFMEMORY	Bei RetrievePipePolicy ist ein Zuordnungsfehler aufgetreten.
Ein Fehlercode, der in "Winerror.h" definiert ist	Dieser Wert entspricht dem Fehlercode, den die WinUsb-API zurückgegeben hat.

Hinweise

Die Piperichtlinie steuert das Verhalten der USB-Pipe (z. B. Timeouts, Behandeln kurzer Pakete usw.).

Weitere Informationen zu gültigen Richtlinientypen, die ein UMDF-Treiber für den PolicyType-Parameter und die vom Framework zurückgegebenen Werte übergeben kann, finden Sie in der funktion WinUsb_GetPipePolicy .

Informationen zum Verhalten der Piperichtlinien finden Sie unter WinUSB Functions for Pipe Policy Modification.

Die RetrievePipePolicy-Methode generiert eine UMDF-Anforderung und sendet die Anforderung synchron an das E/A-Ziel.

Anforderungen

Anforderung	Wert
Ende des Supports	In UMDF 2.0 und höher nicht verfügbar.
Zielplattform	Desktop
UMDF-Mindestversion	1.5
Kopfzeile	wudfusb.h (schließen Sie Wudfusb.h ein)
DLL	WUDFx.dll

Weitere Informationen

IWDFUsbTargetPipe

IWDFUsbTargetPipe::SetPipePolicy

WinUsb_GetPipePolicy