Partager via

Méthode IWDFUsbTargetDevice ::RetrievePowerPolicy (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 RetrievePowerPolicy récupère une stratégie d’alimentation WinUsb.

Syntaxe

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

Paramètres

[in] PolicyType

Type de stratégie d’alimentation WinUsb que le pilote UMDF demande.

[in, out] ValueLength

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

[out] Value

Pointeur qui reçoit la mémoire tampon qui contient la stratégie d’alimentation WinUsb.

Valeur retournée

RetrievePowerPolicy retourne l’une des valeurs suivantes :

Code de retour Description
S_OK

RetrievePowerPolicy a récupéré la stratégie d’alimentation WinUsb.
E_OUTOFMEMORY

RetrievePowerPolicy 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 d’alimentation contrôle la gestion de l’alimentation effectuée par WinUsb pour l’appareil.

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_GetPowerPolicy .

Pour plus d’informations sur le comportement d’alimentation de WinUSB, consultez Gestion de l’alimentation WinUSB.

La méthode RetrievePowerPolicy génère une requête UMDF et envoie de façon 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

IWDFUsbTargetDevice

IWDFUsbTargetDevice ::SetPowerPolicy

WinUsb_GetPowerPolicy