Partager via


WdfDeviceAssignSxWakeSettings, fonction (wdfdevice.h)

[S’applique à KMDF et UMDF]

La méthode WdfDeviceAssignSxWakeSettings fournit des informations sur la capacité d’un appareil à déclencher un signal de veille alors que l’appareil et le système sont dans un état de faible consommation.

Syntaxe

NTSTATUS WdfDeviceAssignSxWakeSettings(
  [in] WDFDEVICE                              Device,
  [in] PWDF_DEVICE_POWER_POLICY_WAKE_SETTINGS Settings
);

Paramètres

[in] Device

Handle pour un objet d’appareil d’infrastructure.

[in] Settings

Pointeur vers une structure de WDF_DEVICE_POWER_POLICY_WAKE_SETTINGS fournie par l’appelant.

Valeur retournée

Si l’opération réussit, WdfDeviceAssignSxWakeSettings retourne STATUS_SUCCESS. Les valeurs de retour supplémentaires sont les suivantes :

Code de retour Description
STATUS_INVALID_DEVICE_REQUEST
Le pilote appelant n’est pas le propriétaire de la stratégie d’alimentation de l’appareil.
STATUS_INVALID_PARAMETER
Une valeur Settings non valide est détectée.
STATUS_INFO_LENGTH_MISMATCH
La taille de la structure WDF_DEVICE_POWER_POLICY_WAKE_SETTINGS est incorrecte.
STATUS_POWER_STATE_INVALID
Le pilote de bus indique que l’appareil ne peut pas déclencher un signal de sortie de veille ou que la structure WDF_DEVICE_POWER_POLICY_WAKE_SETTINGS contient un état d’alimentation du périphérique non valide.
 

La méthode peut retourner d’autres valeurs NTSTATUS.

Un bogue case activée se produit si le pilote fournit un handle d’objet non valide.

Remarques

Pour plus d’informations, consultez Prise en charge de la mise en éveil du système.

Exemples

L’exemple de code suivant initialise une structure WDF_DEVICE_POWER_POLICY_WAKE_SETTINGS, puis appelle WdfDeviceAssignSxWakeSettings. L’exemple utilise les paramètres par défaut que WDF_DEVICE_POWER_POLICY_WAKE_SETTINGS_INIT définit.

WDF_DEVICE_POWER_POLICY_WAKE_SETTINGS  wakeSettings;
NTSTATUS  status = STATUS_SUCCESS;

WDF_DEVICE_POWER_POLICY_WAKE_SETTINGS_INIT(&wakeSettings);

status = WdfDeviceAssignSxWakeSettings(
                                       device,
                                       &wakeSettings
                                       );
if (!NT_SUCCESS(status)) {
    return status;
}

Configuration requise

Condition requise Valeur
Plateforme cible Universal
Version KMDF minimale 1.0
Version UMDF minimale 2.0
En-tête wdfdevice.h (inclure Wdf.h)
Bibliothèque Wdf01000.sys (KMDF) ; WUDFx02000.dll (UMDF)
IRQL <= DISPATCH_LEVEL
Règles de conformité DDI DriverCreate(kmdf), FDOPowerPolicyOwnerAPI(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf), NonFDONotPowerPolicyOwnerAPI(kmdf)

Voir aussi

WDF_DEVICE_POWER_POLICY_WAKE_SETTINGS

WdfDeviceAssignS0IdleSettings