WDF_POWER_DEVICE_STATE enumeration

[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 WDF_POWER_DEVICE_STATE enumeration contains values that identify the power state that a device might support.

Syntax


typedef enum _WDF_POWER_DEVICE_STATE { 
  WdfPowerDeviceInvalid                = 0,
  WdfPowerDeviceD0                     = 1,
  WdfPowerDeviceD1                     = 2,
  WdfPowerDeviceD2                     = 3,
  WdfPowerDeviceD3                     = 4,
  WdfPowerDeviceD3Final                = 5,
  WdfPowerDevicePrepareForHibernation  = 6,
  WdfPowerDeviceMaximum                = ( WdfPowerDevicePrepareForHibernation + 1 )
} WDF_POWER_DEVICE_STATE;

Constants

WdfPowerDeviceInvalid

The device power state is invalid or unknown.

WdfPowerDeviceD0

The device supports the D0 device power state.

WdfPowerDeviceD1

The device supports the D1 device power state.

WdfPowerDeviceD2

The device supports the D2 device power state.

WdfPowerDeviceD3

The device supports the D3 device power state.

WdfPowerDeviceD3Final

The final time that the device enters the D3 device power state. Typically, this value means that the computer's power is being turned off or the device is being removed from the computer. The device might have been already removed.

WdfPowerDevicePrepareForHibernation

The device supports hibernation files, and the computer is ready to hibernate by entering system state S4. The driver must not turn off the device.

WdfPowerDeviceMaximum

Valid enumeration values were exceeded.

Remarks

The framework supplies one of the values of WDF_POWER_DEVICE_STATE to the IPnpCallback::OnD0Entry or IPnpCallback::OnD0Exit method to notify the UMDF driver about the power state of the device.

Requirements

Header

Wudfddi.h (include Wudfddi.h)

See also

IPnpCallback::OnD0Entry
IPnpCallback::OnD0Exit

 

 

Send comments about this topic to Microsoft

Show: