This topic has not yet been rated - Rate this topic

IDTSEvents.OnProgress Method

SQL Server 2012

Called to update progress about task execution.

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

Syntax

C++

JScript

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 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 this should continue firing or stop firing. A value of true indicates that it should continue firing.

Remarks

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.

Reference

IDTSEvents Interface

Microsoft.SqlServer.Dts.Runtime Namespace

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)

Community Additions

ADD