Méthode IWDFUsbInterface ::RetrieveUsbPipeObject (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 RetrieveUsbPipeObject récupère un objet de canal USB pour l’index de canal spécifié.

Syntaxe

HRESULT RetrieveUsbPipeObject(
  [in]  UCHAR             PipeIndex,
  [out] IWDFUsbTargetPipe **ppPipe
);

Paramètres

[in] PipeIndex

Index de l’objet de canal USB à récupérer.

[out] ppPipe

Pointeur vers une variable qui reçoit un pointeur vers l’interface IWDFUsbTargetPipe pour l’objet de canal USB dont l’index est spécifié par PipeIndex.

Valeur retournée

RetrieveUsbPipeObject retourne l’une des valeurs suivantes :

Code de retour	Description
S_OK	RetrieveUsbPipeObject a récupéré l’objet de canal USB.
E_OUTOFMEMORY	RetrieveUsbPipeObject 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

Un pilote UMDF peut appeler les méthodes de l’interface IWDFUsbTargetPipe que la méthode RetrieveUsbPipeObject récupère pour obtenir le type de canal et d’autres informations.

Exemples

Pour obtenir un exemple de code sur l’utilisation de la méthodeRetrieveUsbPipeObject , consultez IWDFUsbInterface ::GetNumEndPoints.

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

Voir aussi

IWDFUsbInterface

IWDFUsbTargetPipe

Partager via