IDTSComponentEvents.FireProgress Method (String, Int32, Int32, Int32, String, Boolean)
Applies To: SQL Server 2016 Preview
Raises an event when measurable progress is made by the executable.
Namespace: Microsoft.SqlServer.Dts.Runtime
Assembly: Microsoft.SqlServer.ManagedDTS (in Microsoft.SqlServer.ManagedDTS.dll)
Syntax
void FireProgress(
string progressDescription,
int percentComplete,
int progressCountLow,
int progressCountHigh,
string subComponent,
ref bool fireAgain
)
void FireProgress(
String^ progressDescription,
int percentComplete,
int progressCountLow,
int progressCountHigh,
String^ subComponent,
bool% fireAgain
)
abstract FireProgress :
progressDescription:string *
percentComplete:int *
progressCountLow:int *
progressCountHigh:int *
subComponent:string *
fireAgain:bool byref -> unit
Sub FireProgress (
progressDescription As String,
percentComplete As Integer,
progressCountLow As Integer,
progressCountHigh As Integer,
subComponent As String,
ByRef fireAgain As Boolean
)
Parameters
progressDescription
Type: System.StringA String that describes the progress event that is raised.
percentComplete
Type: System.Int32An Integer used to indicate how much of the task has completed.
progressCountLow
Type: System.Int32An Integer that contains the low 32-bits of the units completed.
progressCountHigh
Type: System.Int32An Integer that contains the high 32-bits of the units completed.
subComponent
Type: System.StringA String that contains more detail about the event source.
fireAgain
Type: System.BooleanA 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.
See Also
IDTSComponentEvents Interface
Microsoft.SqlServer.Dts.Runtime Namespace
Return to top