WUDF_DEVICE_POWER_POLICY_IDLE_SETTINGS_INIT function

[Applies to UMDF 1.x only]

The WUDF_DEVICE_POWER_POLICY_IDLE_SETTINGS_INIT function initializes a driver's WUDF_DEVICE_POWER_POLICY_IDLE_SETTINGS structure.

Syntax

C++


void WUDF_DEVICE_POWER_POLICY_IDLE_SETTINGS_INIT(
  _Out_  PWUDF_DEVICE_POWER_POLICY_IDLE_SETTINGS Settings,
  _In_   WDF_POWER_POLICY_S0_IDLE_CAPABILITIES IdleCaps
);

Parameters

Settings [out]: A pointer to a driver-allocated WUDF_DEVICE_POWER_POLICY_IDLE_SETTINGS structure.
IdleCaps [in]: A WDF_POWER_POLICY_S0_IDLE_CAPABILITIES-typed enumerator.

Return value

This function does not return a value.

Remarks

First, the WUDF_DEVICE_POWER_POLICY_IDLE_SETTINGS_INIT function zeros the specified WUDF_DEVICE_POWER_POLICY_IDLE_SETTINGS structure and sets the structure's Size member.

Then, the function sets the structure's IdleTimeout member to IdleTimeoutDefaultValue, sets the UserControlOfIdleSettings member to IdleAllowUserControl, and sets the Enabled member to WdfUseDefault.

In addition, the function sets the PowerUpIdleDeviceOnSystemWake member to WdfUseDefault.

The function then sets the ExcludeD3Cold member to WdfUseDefault.

Next, the function sets the structure's IdleCaps member to the value that the IdleCaps parameter specifies.

Finally, if the IdleCaps parameter specifies IdleUsbSelectiveSuspend or IdleCanWakeFromS0, the function sets the DxState member to PowerDeviceMaximum. If the IdleCaps parameter specifies IdleCannotWakeFromS0, the function sets the DxState member to PowerDeviceD3.

For a code example that uses WUDF_DEVICE_POWER_POLICY_IDLE_SETTINGS_INIT, see IWDFDevice3::AssignS0IdleSettingsEx.

Requirements