IIdleSettings::get_WaitTimeout method

Gets or sets a value that indicates the amount of time that the Task Scheduler will wait for an idle condition to occur. If no value is specified for this property, then the Task Scheduler service will wait indefinitely for an idle condition to occur.

This property is read/write.

Syntax

HRESULT get_WaitTimeout(
  BSTR *pTimeout
);

Parameters

pTimeout

Return value

None

Remarks

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

If a task is triggered by an idle trigger, then the WaitTimeout property of the IIdleSettings interface is ignored.

Requirements

   
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

See also

IIdleSettings

Task Scheduler