ITaskSettings::ExecutionTimeLimit property

Gets or sets the amount of time that is allowed to complete the task. By default, a task will be stopped 72 hours after it starts to run. You can change this by changing this setting.

This property is read/write.

Syntax


HRESULT put_ExecutionTimeLimit(
  [in]  BSTR executionTimeLimit
);

HRESULT get_ExecutionTimeLimit(
  [out] BSTR *pExecutionTimeLimit
);

Property value

The amount of time that is allowed to complete the task. When this parameter is set to NULL, the execution time limit is infinite.

Error codes

NameMeaning
S_OK

The property value was successfully set or retrieved.

Remarks

The format for this string is PnYnMnDTnHnMnS, where nY is the number of years, nM is the number of months, nD is the number of days, 'T' is the date/time separator, nH is the number of hours, nM is the number of minutes, and nS is the number of seconds (for example, PT5M specifies 5 minutes and P1M4DT2H5M specifies one month, four days, two hours, and five minutes). A value of PT0S will enable the task to run indefinitely.

Note  If a task is started on demand, the ExecutionTimeLimit setting is bypassed. Therefore, a task that is started on demand will not be terminated if it exceeds the ExecutionTimeLimit.
 

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

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Taskschd.h

Library

Taskschd.lib

DLL

Taskschd.dll

See also

ITaskSettings
Task Scheduler
ITaskSettings

 

 

Community Additions

ADD
Show: