Edit

Share via

POWER_ACTION enumeration (ntpoapi.h)

  • Article

The POWER_ACTION enumeration identifies the system power actions that can occur on a computer.

Syntax

typedef enum  {
  PowerActionNone           = 0,
  PowerActionReserved       = ( PowerActionNone + 1 ),
  PowerActionSleep          = ( PowerActionReserved + 1 ),
  PowerActionHibernate      = ( PowerActionSleep + 1 ),
  PowerActionShutdown       = ( PowerActionHibernate + 1 ),
  PowerActionShutdownReset  = ( PowerActionShutdown + 1 ),
  PowerActionShutdownOff    = ( PowerActionShutdownReset + 1 ),
  PowerActionWarmEject      = ( PowerActionShutdownOff + 1 )
} POWER_ACTION, *PPOWER_ACTION;

Constants

 
PowerActionNone
No power action is taking place.
PowerActionReserved
Reserved for system use.
PowerActionSleep
The computer is entering a system sleeping (S1, S2, or S3) state.
PowerActionHibernate
The computer is entering its hibernation (S4) state.
PowerActionShutdown
The computer is entering its shutdown (S5) state. After all devices have entered their off (D3) state, the computer remains powered on until an administrator presses the power button.
PowerActionShutdownReset
The computer is entering its shutdown (S5) state. After all devices have entered their off (D3) state, the computer automatically powers off and then immediately restarts and returns to its working (S0) state.
PowerActionShutdownOff
The computer is entering its shutdown (S5) state. After all devices have entered their off (D3) state, the computer automatically powers off.
PowerActionWarmEject
The computer is being ejected from an ACPI-compatible dock device. Typically, the computer's power state does not change.
PowerActionDisplayOff

Remarks

The POWER_ACTION enumeration is used as the return value for IWDFDevice2::GetSystemPowerAction.

Requirements

Requirement Value
Header ntpoapi.h (include Wudfddi.h, Ntpoapi.h, Wdm.h)

See also

IWDFDevice2::GetSystemPowerAction