TaskFlags Enumeration

Defines options for a task.

This enumeration has a FlagsAttribute attribute that allows a bitwise combination of its member values.

Namespace: Microsoft.Office.Excel.Server.Addins.ComputeCluster.TaskScheduler
Assembly: Microsoft.Office.Excel.Server.Addins.ComputeCluster (in Microsoft.Office.Excel.Server.Addins.ComputeCluster.dll)

Syntax

'Declaration
<FlagsAttribute> _
Public Enumeration TaskFlags

'Usage
Dim instance As TaskFlags

[FlagsAttribute]
public enum TaskFlags

	Member name	Description
	Interactive	The task is interactive.
	DeleteWhenDone	The task is deleted when there are no more scheduled run times.
	Disabled	The task is disabled. Used to temporarily prevent a task from being triggered normally.
	StartOnlyIfIdle	The task begins only if the computer is idle at the scheduled start time. The computer is not considered idle until the IdleWaitMinutes time for the task elapses with no user input.
	KillOnIdleEnd	The task terminates if the computer makes an idle to non-idle transition while the task is running. For information about idle triggers, see OnIdleTrigger.
	DontStartIfOnBatteries	The task does not start if the computer is running on battery power.
	KillIfGoingOnBatteries	The task ends, and the associated application quits if the computer switches to battery power.
	RunOnlyIfDocked	The task runs only if the system is docked.
	Hidden	The task item is hidden.
	RunIfConnectedToInternet	The task runs only if there is currently a valid Internet connection. Not implemented currently.
	RestartOnIdleResume	The task starts again if the computer makes a non-idle to idle transition before all the task triggers elapse. Use this flag in conjunction with the KillOnIdleEnd value.
	SystemRequired	Wake the computer to run this task.
	RunOnlyIfLoggedOn	The task runs only if the user specified in the SetAccountInformation method is logged on interactively. This flag has no effect on tasks set to run in the local SYSTEM account.

The options are for the Flags property. The values are combined with | (that is, OR) because they include the FlagsAttribute field.

For more information about using the FlagsAttribute field, see FlagsAttribute Class.