Méthode IWDFUsbTargetDevice ::RetrieveUsbInterface (wudfusb.h)

Article
03/01/2024

[Avertissement : UMDF 2 est la dernière version d’UMDF et remplace UMDF 1. Tous les nouveaux pilotes UMDF doivent être écrits à l’aide d’UMDF 2. Aucune nouvelle fonctionnalité n’est ajoutée à UMDF 1 et la prise en charge d’UMDF 1 est limitée sur les versions plus récentes de Windows 10. Les pilotes Windows universels doivent utiliser UMDF 2. Pour plus d’informations, consultez Prise en main avec UMDF.]

La méthode RetrieveUsbInterface récupère l’interface USB spécifiée pour un périphérique USB.

Syntaxe

HRESULT RetrieveUsbInterface(
  [in]  UCHAR            InterfaceIndex,
  [out] IWDFUsbInterface **ppUsbInterface
);

Paramètres

[in] InterfaceIndex

Index de l’interface à récupérer.

[out] ppUsbInterface

Pointeur vers une variable qui reçoit un pointeur vers l’interface IWDFUsbInterface spécifiée pour le périphérique USB.

Valeur retournée

RetrieveUsbInterface retourne l’une des valeurs suivantes :

Code de retour	Description
S_OK	RetrieveUsbInterface a récupéré l’interface USB spécifiée pour le périphérique USB.
E_OUTOFMEMORY	RetrieveUsbInterface a rencontré un échec d’allocation.
Code d’erreur défini dans Winerror.h	Cette valeur correspond au code d’erreur retourné par l’API WinUsb.

Remarques

Le pilote peut appeler la méthode IWDFUsbTargetDevice ::GetNumInterfaces pour récupérer le nombre total d’interfaces USB disponibles.

Le pilote peut utiliser le pointeur d’interface récupéré par RetrieveUsbInterface pour appeler les méthodes fournies par l’interface IWDFUsbInterface . Pour plus d’informations sur l’utilisation de ces méthodes, consultez Utilisation d’interfaces USB dans UMDF.

Exemples

Pour obtenir un exemple de code montrant comment utiliser la méthode RetrieveUsbInterface , consultez IWDFUsbTargetFactory ::CreateUsbTargetDevice.

Configuration requise

Condition requise	Valeur
Fin de la prise en charge	Non disponible dans UMDF 2.0 et versions ultérieures.
Plateforme cible	Desktop (Expérience utilisateur)
Version UMDF minimale	1.5
En-tête	wudfusb.h (inclure Wudfusb.h)
DLL	WUDFx.dll