IdleSettings object

Scripting object 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.

Members

The IdleSettings object has these types of members:

Properties

The IdleSettings object has these properties.

Property Access type Description
IdleDuration
Read/write
Gets or sets a value that indicates the amount of time that the computer must be in an idle state before the task is run.
RestartOnIdle
Read/write
Gets or sets a Boolean value that indicates whether the task is restarted when the computer cycles into an idle condition more than once.
StopOnIdleEnd
Read/write
Gets or sets a Boolean value that indicates that the Task Scheduler will terminate the task if the idle condition ends before the task is completed.
WaitTimeout
Read/write
Gets or sets a value that indicates the amount of time that the Task Scheduler will wait for an idle condition to occur.

Remarks

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

If a task is triggered by an idle trigger, then the IdleSettings.WaitTimeout property is ignored.

Requirements

Minimum supported client
Windows Vista [desktop apps only]
Minimum supported server
Windows Server 2008 [desktop apps only]
Type library
Taskschd.tlb
DLL
Taskschd.dll

See also

Task Scheduler Objects

Task Scheduler