IDTSComponentEvents.FireProgress Method

Article
12/03/2008

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 _
)

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
)

void FireProgress (
    String progressDescription, 
    int percentComplete, 
    int progressCountLow, 
    int progressCountHigh, 
    String subComponent, 
    /** @ref */ boolean fireAgain
)

JScript does not support passing value-type arguments by reference.

Parameters

progressDescription
A String that describes the progress event that is raised.

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

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

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

subComponent
A String that contains more detail about the event source.

fireAgain
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.

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Share via