WdfUsbTargetPipeWdmGetPipeHandle-Funktion (wdfusb.h)
[Gilt nur für KMDF]
Die WdfUsbTargetPipeWdmGetPipeHandle-Methode gibt das USBD_PIPE_HANDLE typisierte Handle zurück, das einem angegebenen Frameworkpipeobjekt zugeordnet ist.
Syntax
USBD_PIPE_HANDLE WdfUsbTargetPipeWdmGetPipeHandle(
[in] WDFUSBPIPE UsbPipe
);
Parameter
[in] UsbPipe
Ein Handle für ein Framework-Pipeobjekt, das durch Aufrufen von WdfUsbInterfaceGetConfiguredPipe abgerufen wurde.
Rückgabewert
WdfUsbTargetPipeWdmGetPipeHandle gibt ein USBD_PIPE_HANDLE typisiertes Handle zurück.
Eine Fehlerüberprüfung tritt auf, wenn der Treiber ein ungültiges Objekthandle bereitstellt.
Hinweise
Ein frameworkbasierter Treiber muss nur dann ein USBD_PIPE_HANDLE typisiertes Handle abrufen, wenn er eine URB erstellt, die ein Pipehandle erfordert.
Der Treiber kann die WdfUsbTargetPipeWdmGetPipeHandle-Methode aufrufen, nachdem er WdfUsbTargetDeviceSelectConfig aufgerufen hat. Das USBD_PIPE_HANDLE-typisierte Handle, das WdfUsbTargetPipeWdmGetPipeHandle zurückgibt, ist gültig, bis der Treiber WdfUsbTargetDeviceSelectConfig erneut aufruft, der Treiber WdfUsbInterfaceSelectSetting aufruft oder das Framework-Pipeobjekt gelöscht wird. 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 WdfUsbInterfaceSelectSetting aufruft, ist das Handle gültig, bis die EvtCleanupCallback-Funktion des Objekts zurückgibt.
Weitere Informationen zur WdfUsbTargetPipeWdmGetPipeHandle-Methode und USB-E/A-Zielen finden Sie unter USB-E/A-Ziele.
Beispiele
Im folgenden Codebeispiel wird das USBD_PIPE_HANDLE-Handle für eine angegebene Pipe abgerufen.
USBD_PIPE_HANDLE usbdPipeHandle;
usbdPipeHandle = WdfUsbTargetPipeWdmGetPipeHandle(UsbPipe);
Anforderungen
| Anforderung | Wert |
|---|---|
| Zielplattform | Universell |
| KMDF-Mindestversion | 1.0 |
| Kopfzeile | wdfusb.h (wdfusb.h einschließen) |
| Bibliothek | Wdf01000.sys (siehe Versionsverwaltung der Frameworkbibliothek).) |
| IRQL | <=DISPATCH_LEVEL |
| DDI-Complianceregeln | DriverCreate(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf), UsbKmdfIrql(kmdf), UsbKmdfIrql2(kmdf), UsbKmdfIrqlExplicit(kmdf) |