ITaskSettings::Enabled property

Gets or sets a Boolean value that indicates that the task is enabled. The task can be performed only when this setting is True.

This property is read-only.

Syntax


HRESULT get_Enabled(
  [out] VARIANT_BOOL *pEnabled
);

Property value

If True, the task is enabled. If False, the task is not enabled.

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 Enabled (settingsType) 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: