Export (0) Print
Expand All

IDTSEvents.OnProgress Method

Called to update progress about task execution.

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

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: String
A string that describes the progress event that is raised.
percentComplete
Type: Int32
An integer used to indicate how much of the task has completed.
progressCountLow
Type: Int32
An integer that contains the low 32-bits of the units completed.
progressCountHigh
Type: Int32
An integer that contains the high 32-bits of the units completed.
subComponent
Type: String
A string that contains more detail about the event source.
fireAgain
Type: Boolean
A Boolean that indicates this should continue firing or stop firing. A value of true indicates that it should continue firing.

Called any time a task experiences measurable progress. 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 about the progress of a particular task.

Community Additions

ADD
Show:
© 2014 Microsoft