DefaultEvents.OnProgress Method

Artigo
12/03/2008

This method is called anytime a task experiences measurable progress.

Namespace: Microsoft.SqlServer.Dts.Runtime
Assembly: Microsoft.SqlServer.ManagedDTS (in microsoft.sqlserver.manageddts.dll)

Syntax

'Declaration
Public Overridable Sub OnProgress ( _
    taskHost As TaskHost, _
    progressDescription As String, _
    percentComplete As Integer, _
    progressCountLow As Integer, _
    progressCountHigh As Integer, _
    subComponent As String, _
    ByRef fireAgain As Boolean _
)

public virtual void OnProgress (
    TaskHost taskHost,
    string progressDescription,
    int percentComplete,
    int progressCountLow,
    int progressCountHigh,
    string subComponent,
    ref bool fireAgain
)

public:
virtual void OnProgress (
    TaskHost^ taskHost, 
    String^ progressDescription, 
    int percentComplete, 
    int progressCountLow, 
    int progressCountHigh, 
    String^ subComponent, 
    bool% fireAgain
)

public void OnProgress (
    TaskHost taskHost, 
    String progressDescription, 
    int percentComplete, 
    int progressCountLow, 
    int progressCountHigh, 
    String subComponent, 
    /** @ref */ boolean fireAgain
)

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

Parameters

taskHost
A null value.

progressDescription
A string that describes the progress of the 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 whether this should continue firing or stop firing. A value of true indicates that it should continue firing.

Remarks

Each task has its own requirements, but as a general rule, a task reports progress in increments of 1 percent. OnProgress is called by the task at predetermined intervals to update listening clients on the progress of a particular task.

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.

Partilhar via