Edit

WdfDeviceInitRegisterPowerStateChangeCallback function (wdfdevice.h)

  • Article

[Applies to KMDF only]

Note

This method is for Microsoft internal use only.

The WdfDeviceInitRegisterPowerStateChangeCallback method registers a driver-supplied event callback function that the framework calls when a device's power state machine changes state.

Syntax

NTSTATUS WdfDeviceInitRegisterPowerStateChangeCallback(
  [in] PWDFDEVICE_INIT                                DeviceInit,
  [in] WDF_DEVICE_POWER_STATE                         PowerState,
  [in] PFN_WDF_DEVICE_POWER_STATE_CHANGE_NOTIFICATION EvtDevicePowerStateChange,
  [in] ULONG                                          CallbackTypes
);

Parameters

[in] DeviceInit

A caller-supplied pointer to a WDFDEVICE_INIT structure.

[in] PowerState

A WDF_DEVICE_POWER_STATE enumerator that identifies the power machine state for which the driver is requesting notification.

[in] EvtDevicePowerStateChange

A caller-supplied pointer to the driver's EvtDevicePowerStateChange event callback function.

[in] CallbackTypes

An ORed combination of WDF_STATE_NOTIFICATION_TYPE-typed enumerators.

Return value

If the operation succeeds, WdfDeviceInitRegisterPowerStateChangeCallback returns STATUS_SUCCESS. Additional return values include:

Return code Description
STATUS_INVALID_PARAMETER
 An invalid parameter was detected.
STATUS_INSUFFICIENT_RESOURCES
 There is insufficient memory to complete the operation.

Remarks

If your driver calls WdfDeviceInitRegisterPowerStateChangeCallback, it must do so before it calls WdfDeviceCreate.

For more information about calling WdfDeviceCreate, see State Machines in the Framework.

Examples

The following code example registers an event callback function that the framework will call when the device's power state machine changes state.

status = WdfDeviceInitRegisterPowerStateChangeCallback(
                                     DeviceInit,
                                     WdfDevStatePowerD0StartingConnectInterrupt,
                                     PciDrvPowerStateChangeCallback,
                                     StateNotificationAllStates
                                     );

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 PASSIVE_LEVEL
DDI compliance rules ChildDeviceInitAPI(kmdf), DeviceInitAPI(kmdf), DriverCreate(kmdf), InitFreeDeviceCallback(kmdf), InitFreeDeviceCreate(kmdf), InitFreeNull(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf), PdoDeviceInitAPI(kmdf), PdoInitFreeDeviceCallback(kmdf), PdoInitFreeDeviceCreate(kmdf)