Edit

POWER_ACTION enumeration (wudfddi.h)

  • Article

[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.

Syntax

typedef enum __MIDL___MIDL_itf_wudfddi_0000_0000_0001 {
  PowerActionNone,
  PowerActionReserved,
  PowerActionSleep,
  PowerActionHibernate,
  PowerActionShutdown,
  PowerActionShutdownReset,
  PowerActionShutdownOff,
  PowerActionWarmEject
} 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.

Remarks

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

Requirements

Requirement Value
Minimum UMDF version 1.9
Header wudfddi.h (include Wudfddi.h, Ntpoapi.h, Wdm.h)

See also

IWDFDevice2::GetSystemPowerAction