IDTSComponentEvents.FireProgress Method
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
'Declaration
Sub FireProgress ( _
progressDescription As String, _
percentComplete As Integer, _
progressCountLow As Integer, _
progressCountHigh As Integer, _
subComponent As String, _
ByRef fireAgain As Boolean _
)
'Usage
Dim instance As IDTSComponentEvents
Dim progressDescription As String
Dim percentComplete As Integer
Dim progressCountLow As Integer
Dim progressCountHigh As Integer
Dim subComponent As String
Dim fireAgain As Boolean
instance.FireProgress(progressDescription, _
percentComplete, progressCountLow, _
progressCountHigh, subComponent, _
fireAgain)
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
function FireProgress(
progressDescription : String,
percentComplete : int,
progressCountLow : int,
progressCountHigh : int,
subComponent : String,
fireAgain : boolean
)
Parameters
- 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
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.