IIdleSettings interface (taskschd.h)
Specifies how the Task Scheduler performs tasks when the computer is in an idle condition. For information about idle conditions, see Task Idle Conditions.
Inheritance
The IIdleSettings interface inherits from the IDispatch interface.
Methods
The IIdleSettings interface has these methods.
| IIdleSettings::get_IdleDuration 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. (Get) |
| IIdleSettings::get_RestartOnIdle Gets or sets a Boolean value that indicates whether the task is restarted when the computer cycles into an idle condition more than once. (Get) |
| IIdleSettings::get_StopOnIdleEnd 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. The idle condition ends when the computer is no longer idle. (Get) |
| IIdleSettings::get_WaitTimeout Gets or sets a value that indicates the amount of time that the Task Scheduler will wait for an idle condition to occur. (Get) |
| IIdleSettings::put_IdleDuration 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. (Put) |
| IIdleSettings::put_RestartOnIdle Gets or sets a Boolean value that indicates whether the task is restarted when the computer cycles into an idle condition more than once. (Put) |
| IIdleSettings::put_StopOnIdleEnd 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. The idle condition ends when the computer is no longer idle. (Put) |
| IIdleSettings::put_WaitTimeout Gets or sets a value that indicates the amount of time that the Task Scheduler will wait for an idle condition to occur. (Put) |
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 WaitTimeout property of the IIdleSettings interface is ignored.
Examples
For more information and example code for this interface, see Time Trigger Example (C++).
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 |
See also
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for