Share via


PackageUpgradeResult.OnProgress Method

This API supports the SQL Server 2012 infrastructure and is not intended to be used directly from your code.

Called to update progress about task execution.

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

Syntax

'Declaration
Public Sub OnProgress ( _
    taskHost As TaskHost, _
    progressDescription As String, _
    percentComplete As Integer, _
    progressCountLow As Integer, _
    progressCountHigh As Integer, _
    subComponent As String, _
    ByRef fireAgain As Boolean _
)
'Usage
Dim instance As PackageUpgradeResult 
Dim taskHost As TaskHost 
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.OnProgress(taskHost, progressDescription, _
    percentComplete, progressCountLow, _
    progressCountHigh, subComponent, _
    fireAgain)
public 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
) sealed
abstract OnProgress : 
        taskHost:TaskHost * 
        progressDescription:string * 
        percentComplete:int * 
        progressCountLow:int * 
        progressCountHigh:int * 
        subComponent:string * 
        fireAgain:bool byref -> unit  
override OnProgress : 
        taskHost:TaskHost * 
        progressDescription:string * 
        percentComplete:int * 
        progressCountLow:int * 
        progressCountHigh:int * 
        subComponent:string * 
        fireAgain:bool byref -> unit
public final function OnProgress(
    taskHost : TaskHost, 
    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%
    True if the object should continue firing; otherwise, false.

Implements

IDTSEvents.OnProgress(TaskHost, String, Int32, Int32, Int32, String, Boolean%)

See Also

Reference

PackageUpgradeResult Class

Microsoft.SqlServer.Dts.Runtime Namespace