ITaskSettings::StopIfGoingOnBatteries property

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(
  [in]  VARIANT_BOOL stopIfOnBatteries
);

HRESULT get_StopIfGoingOnBatteries(
  [out] VARIANT_BOOL *pStopIfOnBatteries
);

Property value

A Boolean value that indicates that the task will be stopped if the computer is going onto batteries. If True, the property indicates that the task will be stopped if the computer is going onto batteries. If False, the property indicates that the task will not be stopped if the computer is going onto batteries. The default is True. See Remarks for more details.

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 StopIfGoingOnBatteries 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

ITaskSettings
Task Scheduler
ITaskSettings

 

 

Show: