ITaskSettings::RunOnlyIfIdle property

Gets or sets a Boolean value that indicates that the Task Scheduler will run the task only if the computer is in an idle condition.

This property is read/write.

Syntax


HRESULT put_RunOnlyIfIdle(
  [in]  VARIANT_BOOL runOnlyIfIdle
);

HRESULT get_RunOnlyIfIdle(
  [out] VARIANT_BOOL *pRunOnlyIfIdle
);

Property value

If True, the property indicates that the Task Scheduler will run the task only if the computer is in an idle condition. The default is False.

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 RunOnlyIfIdle 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
ITaskSettings

 

 

Show: