TaskProgressCollectionStatus Enum

Definition

Namespace:

Microsoft.VisualStudio.TaskStatusCenter

Assembly:

Microsoft.VisualStudio.Shell.Framework.dll

Package:

Microsoft.VisualStudio.Shell.Framework v17.9.37000

Represents the status of an IVsTaskProgressCollection.

This enumeration supports a bitwise combination of its member values.

public enum class TaskProgressCollectionStatus

[System.Flags]
public enum TaskProgressCollectionStatus

[<System.Flags>]
type TaskProgressCollectionStatus = 

Public Enum TaskProgressCollectionStatus

Inheritance

Enum

TaskProgressCollectionStatus

Attributes

FlagsAttribute

Fields

Canceled	8	One or more tasks in the collection was canceled. The Tasks collection can be inspected to determine which tasks were canceled.
Completed	2	All of the tasks in the collection completed.
Faulted	4	One or more tasks in the collection faulted. The Tasks collection can be inspected to determine which tasks faulted.
Running	1	One or more tasks in the collection is running.
WaitingToRun	0	All of the tasks in the collection are waiting to run.

Remarks

A collection starts with a status of WaitingToRun. Once the first task in the collection begins to run, the status changes to Running. When every task in the collection has finished running (regardless of how it finished), the Running bit will be removed and the Completed bit will be added to the status.

As tasks in the collection complete with a status of something other than RanToCompletion, the Canceled and/or Faulted bits will be added to the status, as appropriate. A collection with a status of (Running | Faulted | Canceled) has at least one task that is still executing, at least one task that faulted, and at least one task that was canceled. When all the tasks in this collection have finished running, the collection's status will change to (Completed | Faulted | Canceled). Individual entries in the Tasks collection can be inspected to determine which tasks ran to completion, which ones faulted, and which ones were canceled.