Export (0) Print
Expand All

IIdleSettings::RestartOnIdle property

Gets or sets a Boolean value that indicates whether the task is restarted when the computer cycles into an idle condition more than once.

This property is read/write.

Syntax


HRESULT put_RestartOnIdle(
  [in]   VARIANT_BOOL restart
);

HRESULT get_RestartOnIdle(
  [out]  VARIANT_BOOL *pRestart
);

Property value

A Boolean value that indicates whether the task must be restarted when the computer cycles into an idle condition more than once. The default is False.

Error codes

NameMeaning
S_OK

The property value was successfully set or retrieved.

Remarks

This property is only used if the StopOnIdleEnd property is set to True.

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