Expand Minimize

WdfDeviceGetDevicePowerState method

[Applies to KMDF only]

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

Syntax


WDF_DEVICE_POWER_STATE WdfDeviceGetDevicePowerState(
  [in]  WDFDEVICE 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

Most drivers do not need to be aware of the state of the framework's power state machine. 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);

Requirements

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, KmdfIrql, KmdfIrql2

See also

WdfDeviceGetDevicePnpState
WdfDeviceGetDevicePowerPolicyState
WdfDevStateNormalize

 

 

Send comments about this topic to Microsoft

Show:
© 2014 Microsoft