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

Definition

This method is called anytime a task experiences measurable progress.

public:
 virtual void OnProgress(Microsoft::SqlServer::Dts::Runtime::TaskHost ^ taskHost, System::String ^ progressDescription, int percentComplete, int progressCountLow, int progressCountHigh, System::String ^ subComponent, bool % fireAgain);
public virtual void OnProgress (Microsoft.SqlServer.Dts.Runtime.TaskHost taskHost, string progressDescription, int percentComplete, int progressCountLow, int progressCountHigh, string subComponent, ref bool fireAgain);

Parameters

taskHost
TaskHost TaskHost

A null value.

progressDescription
String String

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

percentComplete
Int32 Int32

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

progressCountLow
Int32 Int32

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

progressCountHigh
Int32 Int32

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

subComponent
String String

A string that contains more detail about the event source.

fireAgain

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

Implements

Remarks

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.

Applies to