ITaskSettings::put_StopIfGoingOnBatteries method (taskschd.h)

Gets or sets a Boolean value that indicates that the task will be stopped if the computer is going onto batteries.

This property is read/write.

Syntax

HRESULT put_StopIfGoingOnBatteries(
  VARIANT_BOOL stopIfOnBatteries
);

Parameters

stopIfOnBatteries

Return value

None

Remarks

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

Requirements

Requirement Value
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

ITaskSettings

Task Scheduler