Edit

DisallowStartIfOnBatteries (settingsType) Element

  • Article

Specifies that the task will not be started if the computer is running on batteries.

<xs:element name="DisallowStartIfOnBatteries"
    type="boolean"
 />

The DisallowStartIfOnBatteries element is defined by the settingsType complex type.

Parent element

Element Derived from Description
Settings settingsType Contains the settings that the Task Scheduler uses to perform the task.

Remarks

The default setting for this element is True.

For scripting development, this information is accessed through the TaskSettings.DisallowStartIfOnBatteries property.

For C++ development, this information is accessed through the ITaskSettings::DisallowStartIfOnBatteries property.

Examples

The following XML defines a settings element that does not allow the task to run if the computer is running on batteries.

<Settings>
    <DisallowStartIfOnBatteries>true</DisallowStartIfOnBatteries>
</Settings>

Requirements

Requirement Value
Minimum supported client
 Windows Vista [desktop apps only]
Minimum supported server
 Windows Server 2008 [desktop apps only]

See also

Task Scheduler Schema Elements