WdfDeviceGetDevicePowerPolicyState function (wdfdevice.h)

[Applies to KMDF only]

Note

This function is for Microsoft-internal use only.

The WdfDeviceGetDevicePowerPolicyState method returns the current state of the framework's power policy state machine, for a specified device.

Syntax

WDF_DEVICE_POWER_POLICY_STATE WdfDeviceGetDevicePowerPolicyState(
  [in] WDFDEVICE Device
);

Parameters

[in] Device

A handle to a framework device object.

Return value

WdfDeviceGetDevicePowerPolicyState returns a WDF_DEVICE_POWER_POLICY_STATE-typed enumerator that identifies the current state of the framework's power policy state machine for the specified device.

A bug check occurs if the driver supplies an invalid object handle.

Remarks

For more information about the framework's state machines, see State Machines in the Framework.

The WdfDeviceGetDevicePowerPolicyState method returns a meaningful value only if it is called from within the callback functions that the driver registers when it calls WdfDeviceInitSetPowerPolicyEventCallbacks.

Examples

The following code example obtains the current state of the framework's power policy state machine for a specified device.

WDF_DEVICE_POWER_POLICY_STATE devicePowerPolicyState;

devicePowerPolicyState = WdfDeviceGetDevicePowerPolicyState(Device);

Requirements

Requirement Value
Target Platform Universal
Minimum KMDF version 1.0
Header wdfdevice.h (include Wdf.h)
Library Wdf01000.sys (see Framework Library Versioning.)
IRQL <= DISPATCH_LEVEL
DDI compliance rules DriverCreate(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf)

See also

WdfDevStateNormalize

WdfDeviceGetDevicePnpState

WdfDeviceGetDevicePowerState