Partager via

Méthode IWDFUsbTargetPipe ::RetrievePipePolicy (wudfusb.h)

  • Article

[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 RetrievePipePolicy récupère une stratégie de canal WinUsb.

Syntaxe

HRESULT RetrievePipePolicy(
  [in]      ULONG PolicyType,
  [in, out] ULONG *ValueLength,
  [out]     PVOID Value
);

Paramètres

[in] PolicyType

Type de stratégie de canal WinUsb que le pilote UMDF demande.

[in, out] ValueLength

Pointeur vers une variable qui, en entrée, contient la taille, en octets, de la mémoire tampon que RetrievePipePolicy fournit pour Value. Sur la sortie, ce paramètre contient la taille requise par RetrievePipePolicy pour Value.

[out] Value

Pointeur qui reçoit la mémoire tampon qui contient la stratégie de canal WinUsb.

Valeur retournée

RetrievePipePolicy retourne l’une des valeurs suivantes :

Code de retour Description
S_OK

RetrievePipePolicy a récupéré la stratégie de canal WinUsb.
E_OUTOFMEMORY

RetrievePipePolicy 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

La stratégie de canal contrôle le comportement du canal USB (par exemple, les délais d’expiration, la gestion des paquets courts, etc.).

Pour plus d’informations sur les types de stratégies valides qu’un pilote UMDF peut passer pour le paramètre PolicyType et les valeurs retournées par l’infrastructure, consultez la fonction WinUsb_GetPipePolicy .

Pour plus d’informations sur le comportement des stratégies de canal, consultez WinUSB Functions for Pipe Policy Modification.

La méthode RetrievePipePolicy génère une requête UMDF et envoie de manière synchrone la demande à la cible d’E/S.

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

IWDFUsbTargetPipe

IWDFUsbTargetPipe ::SetPipePolicy

WinUsb_GetPipePolicy