Windows Dev Center

ITaskSettings::DisallowStartIfOnBatteries property

Gets or sets a Boolean value that indicates that the task will not be started if the computer is running on batteries.

This property is read/write.

Syntax


HRESULT put_DisallowStartIfOnBatteries(
  [in]  VARIANT_BOOL disallowStart
);

HRESULT get_DisallowStartIfOnBatteries(
  [out] VARIANT_BOOL *pDisallowStart
);

Property value

A Boolean value that indicates that the task will not be started if the computer is running on batteries. If True, the task will not be started if the computer is running on batteries. If False, the task will be started if the computer is running on batteries. The default is True.

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

 

 

Community Additions

ADD
Show:
© 2015 Microsoft