Aracılığıyla paylaş


IDTSComponentEvents.FireProgress Method

Definition

Raises an event when measurable progress is made by the executable.

public:
 void FireProgress(System::String ^ progressDescription, int percentComplete, int progressCountLow, int progressCountHigh, System::String ^ subComponent, bool % fireAgain);
public void FireProgress (string progressDescription, int percentComplete, int progressCountLow, int progressCountHigh, string subComponent, ref bool fireAgain);
abstract member FireProgress : string * int * int * int * string * bool -> unit
Public Sub FireProgress (progressDescription As String, percentComplete As Integer, progressCountLow As Integer, progressCountHigh As Integer, subComponent As String, ByRef fireAgain As Boolean)

Parameters

progressDescription
String

A String that describes the progress event that is raised.

percentComplete
Int32

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

progressCountLow
Int32

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

progressCountHigh
Int32

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

subComponent
String

A String that contains more detail about the event source.

fireAgain
Boolean

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

Remarks

Because firing of an event may be expensive, the run-time engine provides a mechanism for suppressing events that you are not interested in. Every event firing method has a FireAgain parameter. If the value of this variable is false, after the method returns, the caller will not fire this event again for the duration of the current execution.

Several of the events have a subComponent parameter that allows for even greater granularity in event source identification.

Applies to