ProgressWithCompletion<T> Class

An incremental progress reporting mechanism that also allows asynchronous awaiting for all reports to be processed.

Inheritance Hierarchy

System.Object
  Microsoft.VisualStudio.Threading.ProgressWithCompletion<T>

Namespace:  Microsoft.VisualStudio.Threading
Assembly:  Microsoft.VisualStudio.Threading (in Microsoft.VisualStudio.Threading.dll)

Syntax

'Declaration
Public Class ProgressWithCompletion(Of T) _
    Implements IProgress(Of T)

public class ProgressWithCompletion<T> : IProgress<T>

generic<typename T>
public ref class ProgressWithCompletion : IProgress<T>

type ProgressWithCompletion<'T> =  
    class 
        interface IProgress<'T>
    end

JScript does not support generic types or methods.

Type Parameters

• T
  <typeparam name="T">The type of message sent in progress updates.</typeparam>

The ProgressWithCompletion<T> type exposes the following members.

Constructors

	Name	Description
	ProgressWithCompletion<T>(Action<T>)	Initializes a new instance of ProgressWithCompletion.
	ProgressWithCompletion<T>(Func<T, Task>)	Initializes a new instance of ProgressWithCompletion.

Top

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	WaitAsync	Returns a task that completes when all reported progress has executed.

Top

Explicit Interface Implementations

	Name	Description
	IProgress<T>.Report	Receives a progress update.

Top

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.VisualStudio.Threading Namespace