POWER_ACTION - NtDoc

Native API online documentation, based on the System Informer (formerly Process Hacker) phnt headers
// ntpoapi.h

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;

View the official Windows Driver Kit DDI reference
// wdm.h

typedef enum {
  PowerActionNone,
  PowerActionReserved,
  PowerActionSleep,
  PowerActionHibernate,
  PowerActionShutdown,
  PowerActionShutdownReset,
  PowerActionShutdownOff,
  PowerActionWarmEject,
  PowerActionDisplayOff
} POWER_ACTION, *PPOWER_ACTION;

View the official Windows Driver Kit DDI reference
// wudfddi.h

typedef enum __MIDL___MIDL_itf_wudfddi_0000_0000_0001 {
  PowerActionNone,
  PowerActionReserved,
  PowerActionSleep,
  PowerActionHibernate,
  PowerActionShutdown,
  PowerActionShutdownReset,
  PowerActionShutdownOff,
  PowerActionWarmEject
} POWER_ACTION, *PPOWER_ACTION;

View the official Windows Driver Kit DDI reference

NtDoc

No description available.

Windows Driver Kit DDI reference (ne-ntpoapi-power_action)

*PPOWER_ACTION enumeration (ntpoapi.h)

Description

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

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

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;

Remarks

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

See also

IWDFDevice2::GetSystemPowerAction


Windows Driver Kit DDI reference (ne-wdm-power_action)

POWER_ACTION enumeration (wdm.h)

Description

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

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


Windows Driver Kit DDI reference (ne-wudfddi-__midl___midl_itf_wudfddi_0000_0000_0001)

__MIDL___MIDL_itf_wudfddi_0000_0000_0001 enumeration (wudfddi.h)

Description

[Warning: UMDF 2 is the latest version of UMDF and supersedes UMDF 1. All new UMDF drivers should be written using UMDF 2. No new features are being added to UMDF 1 and there is limited support for UMDF 1 on newer versions of Windows 10. Universal Windows drivers must use UMDF 2. For more info, see Getting Started with UMDF.]

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

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.

Remarks

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

See also

IWDFDevice2::GetSystemPowerAction