WdfDeviceAssignS0IdleSettings 函式 (wdfdevice.h)
[適用於 KMDF 和 UMDF]
WdfDeviceAssignS0IdleSettings 方法會提供驅動程式提供的資訊,讓架構在裝置閑置且系統處於運作中 (S0) 狀態時使用。
語法
NTSTATUS WdfDeviceAssignS0IdleSettings(
[in] WDFDEVICE Device,
[in] PWDF_DEVICE_POWER_POLICY_IDLE_SETTINGS Settings
);
參數
[in] Device
架構裝置物件的句柄。
[in] Settings
呼叫端提供的 WDF_DEVICE_POWER_POLICY_IDLE_SETTINGS 結構的指標。
傳回值
如果作業成功,WdfDeviceAssignS0IdleSettings 會傳回STATUS_SUCCESS。 其他傳回值包括:
傳回碼 | 描述 |
---|---|
|
呼叫驅動程式不是裝置的電源原則擁有者。 |
|
偵測到無效的 Settings 值。 |
|
WDF_DEVICE_POWER_POLICY_IDLE_SETTINGS 結構的大小不正確。 |
|
如果發生下列其中一項,則會傳回此值:
|
方法可能會 傳回其他NTSTATUS 值。
如果驅動程式提供無效的物件句柄,就會發生錯誤檢查。
言論
如果驅動程式將 WDF_DEVICE_POWER_POLICY_IDLE_SETTINGSIdleTimeoutType 成員設定為 SystemManagedIdleTimeout 或 SystemManagedIdleTimeoutWithHint,則必須先呼叫 WdfDeviceAssignS0IdleSettings,再從 EvtDeviceD0Entry傳回 。 一般而言,驅動程式會先從 EvtDriverDeviceAdd呼叫 WdfDeviceAssignS0IdleSettings。
您可以隨時呼叫 WdfDeviceAssignS0IdleSettings。 不過,在驅動程式設定 IdleTimeoutType 成員第一次呼叫 WdfDeviceAssignS0IdleSettings之後,它不得在稍後呼叫此方法時變更此值。
如果驅動程式在 EvtDriverDeviceAdd 中註冊異步通知(例如,呼叫 PoRegisterPowerSettingCallback 或 IoRegisterPlugPlayNotification),驅動程式就不得從其註冊的驅動程式回呼例程中呼叫 WdfDeviceAssignS0IdleSettings。
如需詳細資訊,請參閱 支援閑置電源關閉。
例子
下列程式代碼範例會初始化 WDF_DEVICE_POWER_POLICY_IDLE_SETTINGS 結構、設定 10 秒的閒置逾時值,並呼叫 WdfDeviceAssignS0IdleSettings。
WDF_DEVICE_POWER_POLICY_IDLE_SETTINGS idleSettings;
NTSTATUS status = STATUS_SUCCESS;
WDF_DEVICE_POWER_POLICY_IDLE_SETTINGS_INIT(
&idleSettings,
IdleCanWakeFromS0
);
idleSettings.IdleTimeout = 10000;
status = WdfDeviceAssignS0IdleSettings(
device,
&idleSettings
);
if (!NT_SUCCESS(status)) {
return status;
}
要求
要求 | 價值 |
---|---|
目標平臺 | 普遍 |
最低 KMDF 版本 | 1.0 |
最低 UMDF 版本 | 2.0 |
標頭 | wdfdevice.h (包括 Wdf.h) |
連結庫 | Wdf01000.sys (KMDF):WUDFx02000.dll (UMDF) |
IRQL | <= DISPATCH_LEVEL |
DDI 合規性規則 | DriverCreate(kmdf),FDOPowerPolicyOwnerAPI(kmdf),KmdfIrql(kmdf),KmdfIrql2(kmdf),KmdfIrqlExplicit(kmdf),NonFDONotPowerPolicyOwnerAPI(kmdf) |