EventsObjectWrapper.FireProgress Method
This API supports the SQL Server 2012 infrastructure and is not intended to be used directly from your code.
Raises an event when measurable progress is made by the executable.
Namespace: Microsoft.SqlServer.Dts.Tasks.ScriptTask
Assembly: Microsoft.SqlServer.ScriptTask (in Microsoft.SqlServer.ScriptTask.dll)
Syntax
'Declaration
Public 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 EventsObjectWrapper
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)
public void FireProgress(
string progressDescription,
int percentComplete,
int progressCountLow,
int progressCountHigh,
string subComponent,
ref bool fireAgain
)
public:
void FireProgress(
String^ progressDescription,
int percentComplete,
int progressCountLow,
int progressCountHigh,
String^ subComponent,
bool% fireAgain
)
member FireProgress :
progressDescription:string *
percentComplete:int *
progressCountLow:int *
progressCountHigh:int *
subComponent:string *
fireAgain:bool byref -> unit
public function FireProgress(
progressDescription : String,
percentComplete : int,
progressCountLow : int,
progressCountHigh : int,
subComponent : String,
fireAgain : boolean
)
Parameters
- progressDescription
Type: System.String
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
Contains more detail about the event source.
- fireAgain
Type: System.Boolean%
True to continue firing; otherwise, false.