DefaultEvents.OnProgress Method (TaskHost, String, Int32, Int32, Int32, String, Boolean)

 

This method is called anytime a task experiences measurable progress.

Namespace:   Microsoft.SqlServer.Dts.Runtime
Assembly:  Microsoft.SqlServer.ManagedDTS (in Microsoft.SqlServer.ManagedDTS.dll)

public virtual void OnProgress(
	TaskHost taskHost,
	string progressDescription,
	int percentComplete,
	int progressCountLow,
	int progressCountHigh,
	string subComponent,
	ref bool fireAgain
)

Parameters

taskHost
Type: Microsoft.SqlServer.Dts.Runtime.TaskHost

A null value.

progressDescription
Type: System.String

A string that describes the progress of the event that is raised.

percentComplete
Type: System.Int32

An integer used to indicate how much of the task has completed.

progressCountLow
Type: System.Int32

An integer that contains the low 32-bits of the units completed.

progressCountHigh
Type: System.Int32

An integer that contains the high 32-bits of the units completed.

subComponent
Type: System.String

A string that contains more detail about the event source.

fireAgain
Type: System.Boolean

A Boolean that indicates whether this should continue firing or stop firing. A value of true indicates that it should continue firing.

Each task has its own requirements, but as a general rule, a task reports progress in increments of 1 percent. OnProgress is called by the task at predetermined intervals to update listening clients on the progress of a particular task.

Return to top
Show: