IWDFUsbTargetPipe::RetrievePipePolicy-Methode (wudfusb.h)

Artikel
02/07/2025

[Warnung: UMDF 2 ist die neueste Version von UMDF und ersetzt UMDF 1. Alle neuen UMDF-Treiber sollten mit UMDF 2 geschrieben werden. Es werden keine neuen Features zu UMDF 1 hinzugefügt, und es gibt eingeschränkte Unterstützung für UMDF 1 für neuere Versionen von Windows 10. 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 eingabe die Größe des Puffers in Byte enthält, der RetrievePipePolicy- für Valuebereitstellt. Bei der Ausgabe enthält dieser Parameter die Größe, die RetrievePipePolicy- für Valuebenö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 die WinUsb-Piperichtlinie erfolgreich abgerufen.
E_OUTOFMEMORY	RetrievePipePolicy ein Zuordnungsfehler aufgetreten ist.
Ein Fehlercode, der in winerror.h definiert ist	Dieser Wert entspricht dem Fehlercode, den die WinUsb-API zurückgegeben hat.

Bemerkungen

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 Werte übergeben kann, die das Framework zurückgibt, finden Sie in der WinUsb_GetPipePolicy-Funktion.

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
Mindest-UMDF-Version	1.5
Header-	wudfusb.h (include Wudfusb.h)
DLL-	WUDFx.dll

Siehe auch

IWDFUsbTargetPipe-

IWDFUsbTargetPipe::SetPipePolicy

WinUsb_GetPipePolicy

Freigeben über