ITaskSettings::get_IdleSettings method (taskschd.h)

Article
02/22/2024

Gets or sets the information that specifies how the Task Scheduler performs tasks when the computer is in an idle condition. For information about idle conditions, see Task Idle Conditions.

This property is read/write.

Syntax

HRESULT get_IdleSettings(
  IIdleSettings **ppIdleSettings
);

Parameters

ppIdleSettings

Return value

None

Remarks

When reading or writing XML for a task, this setting is specified in the IdleSettings element of the Task Scheduler schema.

When battery saver is on, Windows Task Scheduler tasks are triggered only if the task is:

Not set to Start the task only if the computer is idle... (task doesn't use IdleSettings)
Not set to run during automatic maintenance (task doesn't use MaintenanceSettings)
Is set to Run only when user is logged on (task LogonType is TASK_LOGON_INTERACTIVE_TOKEN or TASK_LOGON_GROUP)

All other triggers are delayed until battery saver is off. For more information about accessing battery saver status in your application, see SYSTEM_POWER_STATUS. For general information about battery saver, see battery saver (in the hardware component guidelines).

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2008 [desktop apps only]
Target Platform	Windows
Header	taskschd.h
Library	Taskschd.lib
DLL	Taskschd.dll