WUDF_DEVICE_POWER_POLICY_IDLE_SETTINGS_INIT関数 (wudfdevice.h)

[警告: UMDF 2 は UMDF の最新バージョンであり、UMDF 1 よりも優先されます。 すべての新しい UMDF ドライバーは、UMDF 2 を使用して記述する必要があります。 UMDF 1 には新機能が追加されておらず、新しいバージョンのWindows 10では UMDF 1 のサポートが制限されています。 ユニバーサル Windows ドライバーでは、UMDF 2 を使用する必要があります。 詳細については、「UMDF を使用したはじめに」を参照してください。

WUDF_DEVICE_POWER_POLICY_IDLE_SETTINGS_INIT関数は、ドライバーのWUDF_DEVICE_POWER_POLICY_IDLE_SETTINGS構造体を初期化します。

構文

void WUDF_DEVICE_POWER_POLICY_IDLE_SETTINGS_INIT(
  [out] PWUDF_DEVICE_POWER_POLICY_IDLE_SETTINGS Settings,
  [in]  WDF_POWER_POLICY_S0_IDLE_CAPABILITIES   IdleCaps
);

パラメーター

[out] Settings

ドライバーによって割り当てられた WUDF_DEVICE_POWER_POLICY_IDLE_SETTINGS 構造体へのポインター。

[in] IdleCaps

WDF_POWER_POLICY_S0_IDLE_CAPABILITIES型の列挙子。

戻り値

なし

解説

最初に、 WUDF_DEVICE_POWER_POLICY_IDLE_SETTINGS_INIT 関数は、指定した WUDF_DEVICE_POWER_POLICY_IDLE_SETTINGS 構造体をゼロにし、構造体の Size メンバーを設定します。

次に、構造体の IdleTimeout メンバーを IdleTimeoutDefaultValue に設定し、 UserControlOfIdleSettings メンバーを IdleAllowUserControl に設定し、 Enabled メンバーを WdfUseDefault に設定します。

さらに、 関数は PowerUpIdleDeviceOnSystemWake メンバーを WdfUseDefault に設定します。

次に、 ExcludeD3Cold メンバーを WdfUseDefault に設定します。

次に、構造体の IdleCaps メンバーを IdleCaps パラメーターで指定した値に設定します。

最後に、 IdleCaps パラメーターで IdleUsbSelectiveSuspend または IdleCanWakeFromS0 を指定した場合、関数は DxState メンバーを PowerDeviceMaximum に設定します。 IdleCaps パラメーターで IdleCannotWakeFromS0 を指定した場合、関数は DxState メンバーを PowerDeviceD3 に設定します。

WUDF_DEVICE_POWER_POLICY_IDLE_SETTINGS_INITを使用するコード例については、「IWDFDevice3::AssignS0IdleSettingsEx」を参照してください。

要件

要件	値
サポート終了	UMDF 2.0 以降では使用できません。
対象プラットフォーム	デスクトップ
最小 UMDF バージョン	1.11
Header	wudfdevice.h

こちらもご覧ください

IWDFDevice3::AssignS0IdleSettingsEx

WUDF_DEVICE_POWER_POLICY_IDLE_SETTINGS