WdfUsbTargetPipeWdmGetPipeHandle-Funktion (wdfusb.h)
[Gilt nur für KMDF]
Die WdfUsbTargetPipeWdmGetPipeHandle--Methode gibt das USBD_PIPE_HANDLE Typ-Handle zurück, das einem angegebenen Framework-Pipeobjekt zugeordnet ist.
Syntax
USBD_PIPE_HANDLE WdfUsbTargetPipeWdmGetPipeHandle(
[in] WDFUSBPIPE UsbPipe
);
Parameter
[in] UsbPipe
Ein Handle zu einem Framework-Pipeobjekt, das durch Aufrufen WdfUsbInterfaceGetConfiguredPipeabgerufen wurde.
Rückgabewert
WdfUsbTargetPipeWdmGetPipeHandle- gibt einen USBD_PIPE_HANDLE-Typ-Handle zurück.
Wenn der Treiber ein ungültiges Objekthandle bereitstellt, tritt eine Fehlerüberprüfung auf.
Bemerkungen
Ein frameworkbasierter Treiber muss ein USBD_PIPE_HANDLE typisiertes Handle nur abrufen, wenn ein URB- erstellt wird, für das ein Pipehandle erforderlich ist.
Der Treiber kann die WdfUsbTargetPipeWdmGetPipeHandle--Methode aufrufen, nachdem sie WdfUsbTargetDeviceSelectConfigaufgerufen hat. Das USBD_PIPE_HANDLE Typhandle, das WdfUsbTargetPipeWdmGetPipeHandle- zurückgegeben wird, ist gültig, bis der Treiber WdfUsbTargetDeviceSelectConfig erneut aufruft, ruft der Treiber WdfUsbInterfaceSelectSettingauf, oder das Framework-Pipeobjekt wird gelöscht. Wenn der Treiber eine EvtCleanupCallback--Funktion für das Framework-Pipeobjekt bereitstellt und das Objekt gelöscht wird, bevor der Treiber WdfUsbTargetDeviceSelectConfig erneut aufruft oder WdfUsbInterfaceSelectSettingaufruft, ist das Handle gültig, bis die EvtCleanupCallback--Funktion des Objekts zurückgegeben wird.
Weitere Informationen zu den WdfUsbTargetPipeWdmGetPipeHandle Methode und USB-E/A-Zielen finden Sie unter USB I/O Targets.
Beispiele
Im folgenden Codebeispiel wird der USBD_PIPE_HANDLE-Typ-Handle für eine angegebene Pipe abgerufen.
USBD_PIPE_HANDLE usbdPipeHandle;
usbdPipeHandle = WdfUsbTargetPipeWdmGetPipeHandle(UsbPipe);
Anforderungen
| Anforderung | Wert |
|---|---|
| Zielplattform- | Universal |
| Minimale KMDF-Version | 1.0 |
| Header- | wdfusb.h (include Wdfusb.h) |
| Library | Wdf01000.sys (siehe Framework-Bibliotheksversionsverwaltung.) |
| IRQL- | <=DISPATCH_LEVEL |
| DDI-Complianceregeln | DriverCreate(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf), UsbKmdfIrql(kmdf), UsbKmdfIrql2(kmdf), UsbKmdfIrqlExplicit(kmdf) |