SetSuspendState, fonction (powrprof.h)

  • Article

Interrompt le système en arrêtant l’alimentation. Selon le paramètre Hibernate , le système passe à un état de suspension (veille) ou de mise en veille prolongée (S4).

Syntaxe

BOOLEAN SetSuspendState(
  [in] BOOLEAN bHibernate,
  [in] BOOLEAN bForce,
  [in] BOOLEAN bWakeupEventsDisabled
);

Paramètres

[in] bHibernate

Si ce paramètre a la valeur TRUE, le système est en veille prolongée. Si le paramètre a la valeur FALSE, le système est suspendu.

[in] bForce

Ce paramètre est sans effet.

[in] bWakeupEventsDisabled

Si ce paramètre a la valeur TRUE, le système désactive tous les événements de veille. Si le paramètre a la valeur FALSE, tous les événements de sortie de veille système restent activés.

Valeur retournée

Si la fonction réussit, la valeur de retour est différente de zéro.

Si la fonction échoue, la valeur de retour est égale à zéro. Pour obtenir des informations détaillées sur l’erreur, appelez GetLastError.

Remarques

Le processus appelant doit avoir le privilège SE_SHUTDOWN_NAME . Pour activer le privilège SE_SHUTDOWN_NAME , utilisez la fonction AdjustTokenPrivileges . Pour plus d’informations, consultez Modification des privilèges dans un jeton.

Une application peut utiliser SetSuspendState pour faire passer le système de l’état de fonctionnement à l’état de veille (veille) ou éventuellement en veille prolongée (S4). Cette fonction est similaire à la fonction SetSystemPowerState .

Pour plus d’informations sur l’utilisation de PowrProf.h, consultez Power Schemes. Pour plus d’informations sur les événements qui peuvent réveiller le système, consultez Événements de mise en éveil du système.

Configuration requise

Condition requise Valeur
Client minimal pris en charge Windows XP [applications de bureau uniquement]
Serveur minimal pris en charge Windows Server 2003 [applications de bureau uniquement]
Plateforme cible Windows
En-tête powrprof.h
Bibliothèque PowrProf.lib
DLL PowrProf.dll

Voir aussi

PBT_APMQUERYSUSPEND

PBT_APMSUSPEND

Fonctions de gestion de l’alimentation