WdfDeviceGetDevicePowerState - NtDoc

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

WDF_DEVICE_POWER_STATE WdfDeviceGetDevicePowerState(
  [in] WDFDEVICE Device
);
View the official Windows Driver Kit DDI reference

NtDoc

No description available.

Windows Driver Kit DDI reference (nf-wdfdevice-wdfdevicegetdevicepowerstate)

WdfDeviceGetDevicePowerState function

Description

[Applies to KMDF only]

[!NOTE] This function is for Microsoft internal use only.

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

Parameters

Device [in]

A handle to a framework device object.

Return value

WdfDeviceGetDevicePowerState returns a WDF_DEVICE_POWER_STATE-typed enumerator that identifies the current state of the framework's power 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 WdfDeviceGetDevicePowerState method returns a meaningful value only if it is called from within the following callback functions:

Examples

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

WDF_DEVICE_POWER_STATE state;

state = WdfDeviceGetDevicePowerState(Device);

See also

WdfDevStateNormalize

WdfDeviceGetDevicePnpState

WdfDeviceGetDevicePowerPolicyState