IWDFUsbInterface ::RetrieveUsbPipeObject, méthode (wudfusb.h)

Article
02/07/2025

[Avertissement : UMDF 2 est la dernière version de UMDF et remplace UMDF 1. Tous les nouveaux pilotes UMDF doivent être écrits à l’aide de UMDF 2. Aucune nouvelle fonctionnalité n’est ajoutée à UMDF 1 et il existe une prise en charge limitée de UMDF 1 sur les versions plus récentes de Windows 10. Les pilotes Windows universels doivent utiliser UMDF 2. Pour plus d’informations, consultez Bien démarrer 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 de retour

RetrieveUsbPipeObject retourne l’une des valeurs suivantes :

Retourner le code	Description
S_OK	RetrieveUsbPipeObject récupéré avec succès 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 montrant comment utiliser la méthodeRetrieveUsbPipeObject, consultez IWDFUsbInterface ::GetNumEndPoints.

Exigences

Exigence	Valeur
fin du support	Indisponible dans UMDF 2.0 et versions ultérieures.
plateforme cible	Bureau
version minimale de UMDF	1.5
d’en-tête	wudfusb.h (include Wudfusb.h)
DLL	WUDFx.dll

Voir aussi

IWDFUsbInterface

IWDFUsbTargetPipe

Partager via