IWDFUsbInterface::RetrieveUsbPipeObject-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 RetrieveUsbPipeObject-Methode ruft ein USB-Pipeobjekt für den angegebenen Pipeindex ab.
Syntax
HRESULT RetrieveUsbPipeObject(
[in] UCHAR PipeIndex,
[out] IWDFUsbTargetPipe **ppPipe
);
Parameter
[in] PipeIndex
Der Index des abzurufenden USB-Pipeobjekts.
[out] ppPipe
Ein Zeiger auf eine Variable, die einen Zeiger auf die IWDFUsbTargetPipe-Schnittstelle für das USB-Pipeobjekt empfängt, dessen Index durch PipeIndex angegeben wird.
Rückgabewert
RetrieveUsbPipeObject gibt einen der folgenden Werte zurück:
| Rückgabecode | Beschreibung |
|---|---|
|
RetrieveUsbPipeObject hat das USB-Pipeobjekt erfolgreich abgerufen. |
|
Bei RetrieveUsbPipeObject ist ein Zuordnungsfehler aufgetreten. |
|
Dieser Wert entspricht dem Fehlercode, den die WinUsb-API zurückgegeben hat. |
Hinweise
Ein UMDF-Treiber kann die Methoden der IWDFUsbTargetPipe-Schnittstelle aufrufen, die die RetrieveUsbPipeObject-Methode abruft, um den Typ der Pipe und andere Informationen abzurufen.
Beispiele
Ein Codebeispiel zur Verwendung derRetrieveUsbPipeObject-Methode finden Sie unter IWDFUsbInterface::GetNumEndPoints.
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 |