IIdleSettings::put_StopOnIdleEnd method (taskschd.h)

Article
02/22/2024

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.

This property is read/write.

Syntax

HRESULT put_StopOnIdleEnd(
  VARIANT_BOOL stop
);

Parameters

stop

Return value

None

Remarks

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

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