Skip to content

Latest commit

 

History

History
127 lines (101 loc) · 3.64 KB

nf-mstask-itask-setmaxruntime.md

File metadata and controls

127 lines (101 loc) · 3.64 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:mstask.ITask.SetMaxRunTime
ITask::SetMaxRunTime (mstask.h)
This method sets the maximum time the task can run, in milliseconds, before terminating.
ITask interface [Task Scheduler]
SetMaxRunTime method
ITask.SetMaxRunTime
ITask::SetMaxRunTime
SetMaxRunTime
SetMaxRunTime method [Task Scheduler]
SetMaxRunTime method [Task Scheduler]
ITask interface
_msb_itask_setmaxruntime
mstask/ITask::SetMaxRunTime
taskschd.itask_setmaxruntime
taskschd\itask_setmaxruntime.htm
taskschd
fb9012c6-be41-4ec6-bb1a-73bd7896738f
12/05/2018
ITask interface [Task Scheduler],SetMaxRunTime method, ITask.SetMaxRunTime, ITask::SetMaxRunTime, SetMaxRunTime, SetMaxRunTime method [Task Scheduler], SetMaxRunTime method [Task Scheduler],ITask interface, _msb_itask_setmaxruntime, mstask/ITask::SetMaxRunTime, taskschd.itask_setmaxruntime
mstask.h
Windows
Windows 2000 Professional [desktop apps only]
Windows 2000 Server [desktop apps only]
Mstask.lib
Mstask.dll
Windows
Internet Explorer 4.0 or later on Windows NT 4.0 and Windows 95
19H1
ITask::SetMaxRunTime
mstask/ITask::SetMaxRunTime
c++
APIRef
kbSyntax
COM
Mstask.dll
ITask.SetMaxRunTime

ITask::SetMaxRunTime

-description

[[This API may be altered or unavailable in subsequent versions of the operating system or product. Please use the Task Scheduler 2.0 Interfaces instead.] ]

This method sets the maximum time the task can run, in milliseconds, before terminating.

-parameters

-param dwMaxRunTimeMS [in]

A DWORD value that specifies the maximum run time (in milliseconds), for the task. This parameter may be set to INFINITE to specify an unlimited time.

-returns

The SetMaxRunTime method returns one of the following values.

Return code Description
S_OK
The operation was successful.
E_INVALIDARG
The arguments are not valid.
E_OUTOFMEMORY
Not enough memory is available.

-remarks

When the maximum run time is exceeded, the Task Scheduler attempts to terminate the application associated with the task. If a WM_CLOSE message cannot be sent (for example, the application has no windows) or the application has not exited within three minutes of the receiving WM_CLOSE, the Task Scheduler terminates the application using TerminateProcess.

After setting the maximum run time, be sure to call IPersistFile::Save to save the modified task object to disk.

Examples

For an example of how to set the maximum run time, see C/C++ Code Example: Setting MaxRunTime.

-see-also

IGetMaxRunTime

ITask