Edit

ITask::GetMaxRunTime method (mstask.h)

  • Article

[[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 retrieves the maximum length of time, in milliseconds, the task can run before terminating.

Syntax

HRESULT GetMaxRunTime(
  [out] DWORD *pdwMaxRunTimeMS
);

Parameters

[out] pdwMaxRunTimeMS

A pointer to a DWORD that contains the maximum run time of the current task.

If the maximum run time is reached during the execution of a task, the Task Scheduler first sends a WM_CLOSE message to the associated application. If the application does not exit within three minutes, TerminateProcess is run.

Return value

The GetMaxRunTime 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.

Requirements

Requirement Value
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header mstask.h
Library Mstask.lib
DLL Mstask.dll
Redistributable Internet Explorer 4.0 or later on Windows NT 4.0 and Windows 95

See also

ITask

SetMaxRunTime