ITaskSettings::put_StartWhenAvailable method (taskschd.h)

Article
02/22/2024

Gets or sets a Boolean value that indicates that the Task Scheduler can start the task at any time after its scheduled time has passed.

This property is read/write.

Syntax

HRESULT put_StartWhenAvailable(
  VARIANT_BOOL startWhenAvailable
);

Parameters

startWhenAvailable

Return value

None

Remarks

This property applies only to time-based tasks with an end boundary or time-based tasks that are set to repeat infinitely.

Tasks that are started after the scheduled time has passed (because of the StartWhenAvailable property being set to True) are queued in the Task Scheduler service's queue of tasks and they are started after a delay. The default delay is 10 minutes.

When reading or writing XML for a task, this setting is specified in the StartWhenAvailable 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