Export (0) Print
Expand All

IIdleSettings::StopOnIdleEnd property

Gets or sets a Boolean value that indicates that the Task Scheduler will terminate the task if the idle condition ends before the task is completed. The idle condition ends when the computer is no longer idle.

This property is read/write.

Syntax


HRESULT put_StopOnIdleEnd(
  [in]   VARIANT_BOOL stop
);

HRESULT get_StopOnIdleEnd(
  [out]  VARIANT_BOOL *pStop
);

Property value

A Boolean value that indicates that the Task Scheduler will terminate the task if the idle condition ends before the task is completed. The idle condition ends when the computer is no longer idle.

Error codes

NameMeaning
S_OK

The property value was successfully set or retrieved.

Remarks

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

Task Scheduler
IIdleSettings

 

 

Community Additions

ADD
Show:
© 2014 Microsoft