Partager via


IWDFUsbTargetDevice ::RetrievePowerPolicy, méthode (wudfusb.h)

[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 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, en entrée, contient la taille, en octets, de la mémoire tampon qui RetrievePowerPolicy fournit dans Valeur. En sortie, ce paramètre contient la taille requise par RetrievePowerPolicy pour valeur.

[out] Value

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

Valeur de retour

RetrievePowerPolicy retourne l’une des valeurs suivantes :

Retourner le code Description
S_OK

RetrievePowerPolicy récupéré avec succès 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égie valides qu’un pilote UMDF peut transmettre 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 de l’alimentation de WinUSB, consultez Gestion de l’alimentation WinUSB.

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

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

IWDFUsbTargetDevice

IWDFUsbTargetDevice ::SetPowerPolicy

WinUsb_GetPowerPolicy