IdleSettings object
A 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.
Note
The IdleDuration and WaitTimeout settings are deprecated. They're still present in the Task Scheduler user interface, and their interface methods may still return valid values, but they're no longer used.
| Property | Access type | Description |
|---|---|---|
| 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. |
| Deprecated: 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. |
| Deprecated: 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.
Note
IdleSettings.IdleDuration and IdleSettings.WaitTimeout are deprecated.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client |
Windows Vista [desktop apps only] |
| Minimum supported server |
Windows Server 2008 [desktop apps only] |
| Type library |
|
| DLL |
|