WdfUsbTargetPipeWdmGetPipeHandle, fonction (wdfusb.h)

[S’applique uniquement à KMDF]

La méthode WdfUsbTargetPipeWdmGetPipeHandle retourne le handle USBD_PIPE_HANDLE typé associé à un objet de canal d’infrastructure spécifié.

Syntaxe

USBD_PIPE_HANDLE WdfUsbTargetPipeWdmGetPipeHandle(
  [in] WDFUSBPIPE UsbPipe
);

Paramètres

[in] UsbPipe

Handle vers un objet de canal d’infrastructure obtenu en appelant WdfUsbInterfaceGetConfiguredPipe.

Valeur de retour

WdfUsbTargetPipeWdmGetPipeHandle retourne un handle USBD_PIPE_HANDLE typé.

Une vérification de bogue se produit si le pilote fournit un handle d’objet non valide.

Remarques

Un pilote basé sur l’infrastructure doit obtenir un handle USBD_PIPE_HANDLE typé uniquement s’il crée un URB qui nécessite un handle de canal.

Le pilote peut appeler la méthode WdfUsbTargetPipeWdmGetPipeHandle après avoir appelé WdfUsbTargetDeviceSelectConfig. Le handle USBD_PIPE_HANDLE typé que WdfUsbTargetPipeWdmGetPipeHandle retourne est valide jusqu’à ce que le pilote appelle WdfUsbTargetDeviceSelectConfig à nouveau, le pilote appelle WdfUsbInterfaceSelectSetting ou l’objet de canal d’infrastructure est supprimé. Si le pilote fournit une fonction EvtCleanupCallback pour l’objet de canal d’infrastructure, et si l’objet est supprimé avant que le pilote appelle WdfUsbTargetSelectConfig à nouveau ou appelle WdfUsbInterfaceSelectSetting, le handle est valide jusqu’à ce que la fonction EvtCleanupCallback de l’objet retourne.

Pour plus d’informations sur la méthode WdfUsbTargetPipeWdmGetPipeHandle et les cibles d’E/S USB, consultez les cibles d’E/S USB.

Exemples

L’exemple de code suivant obtient le handle USBD_PIPE_HANDLE typé pour un canal spécifié.

USBD_PIPE_HANDLE  usbdPipeHandle;

usbdPipeHandle = WdfUsbTargetPipeWdmGetPipeHandle(UsbPipe);

Configuration requise

   
Plateforme cible Universal
Version KMDF minimale 1.0
En-tête wdfusb.h (inclure Wdfusb.h)
Bibliothèque Wdf01000.sys (voir Versioning de la bibliothèque Framework.)
IRQL <=DISPATCH_LEVEL
Règles de conformité DDI DriverCreate(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf), UsbKmdfIrql(kmdf), UsbKmdfIrql2(kmdf), UsbKmdfIrql2(kmdf), UsbKmdfIrqlExplicit(kmdf)

Voir aussi

Urb

WdfUsbInterfaceGetConfiguredPipe

WdfUsbTargetDeviceSelectConfig