WDF_DEVICE_POWER_POLICY_IDLE_SETTINGS_INIT関数 (wdfdevice.h)
[KMDF と UMDF に適用]
WDF_DEVICE_POWER_POLICY_IDLE_SETTINGS_INIT関数は、ドライバーのWDF_DEVICE_POWER_POLICY_IDLE_SETTINGS構造体を初期化します。
構文
void WDF_DEVICE_POWER_POLICY_IDLE_SETTINGS_INIT(
[out] PWDF_DEVICE_POWER_POLICY_IDLE_SETTINGS Settings,
[in] WDF_POWER_POLICY_S0_IDLE_CAPABILITIES IdleCaps
);
パラメーター
[out] Settings
ドライバーによって割り当てられた WDF_DEVICE_POWER_POLICY_IDLE_SETTINGS 構造体へのポインター。
[in] IdleCaps
WDF_POWER_POLICY_S0_IDLE_CAPABILITIES型の列挙子。
戻り値
なし
解説
最初に、 WDF_DEVICE_POWER_POLICY_IDLE_SETTINGS_INIT 関数は、指定した WDF_DEVICE_POWER_POLICY_IDLE_SETTINGS 構造体を 0 にし、構造体の Size メンバーを設定します。
次に、構造体の IdleTimeout メンバーを IdleTimeoutDefaultValue に設定し、 UserControlOfIdleSettings メンバーを IdleAllowUserControl に設定し、 Enabled メンバーを WdfUseDefault に設定します。
さらに、関数は PowerUpIdleDeviceOnSystemWake メンバーを WdfUseDefault に、 IdleTimeoutType メンバーを DriverManagedIdleTimeout に設定します。
さらに、 関数は ExcludeD3Cold メンバーを WdfUseDefault に設定します。
次に、構造体の IdleCaps メンバーを IdleCaps パラメーターで指定した値に設定します。
最後に、 IdleCaps パラメーターで IdleUsbSelectiveSuspend または IdleCanWakeFromS0 を指定した場合、関数は DxState メンバーを PowerDeviceMaximum に設定します。 IdleCaps パラメーターで IdleCannotWakeFromS0 を指定した場合、関数は DxState メンバーを PowerDeviceD3 に設定します。
例
WDF_DEVICE_POWER_POLICY_IDLE_SETTINGS_INITを使用するコード例については、「WdfDeviceAssignS0IdleSettings」を参照してください。
要件
| 要件 | 値 |
|---|---|
| 対象プラットフォーム | ユニバーサル |
| 最小 KMDF バージョン | 1.0 |
| 最小 UMDF バージョン | 2.0 |
| Header | wdfdevice.h (Wdf.h を含む) |