Поделиться через


Метод OnProgress

Called to update progress about task execution.

Пространство имен:  Microsoft.SqlServer.Dts.Runtime
Сборка:  Microsoft.SqlServer.ManagedDTS (в Microsoft.SqlServer.ManagedDTS.dll)

Синтаксис

'Декларация
Sub OnProgress ( _
    taskHost As TaskHost, _
    progressDescription As String, _
    percentComplete As Integer, _
    progressCountLow As Integer, _
    progressCountHigh As Integer, _
    subComponent As String, _
    ByRef fireAgain As Boolean _
)
'Применение
Dim instance As IDTSEvents
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)
void OnProgress(
    TaskHost taskHost,
    string progressDescription,
    int percentComplete,
    int progressCountLow,
    int progressCountHigh,
    string subComponent,
    ref bool fireAgain
)
void OnProgress(
    TaskHost^ taskHost, 
    String^ progressDescription, 
    int percentComplete, 
    int progressCountLow, 
    int progressCountHigh, 
    String^ subComponent, 
    bool% fireAgain
)
abstract OnProgress : 
        taskHost:TaskHost * 
        progressDescription:string * 
        percentComplete:int * 
        progressCountLow:int * 
        progressCountHigh:int * 
        subComponent:string * 
        fireAgain:bool byref -> unit 
function OnProgress(
    taskHost : TaskHost, 
    progressDescription : String, 
    percentComplete : int, 
    progressCountLow : int, 
    progressCountHigh : int, 
    subComponent : String, 
    fireAgain : boolean
)

Параметры

  • progressDescription
    Тип: System. . :: . .String
    A string that describes the progress event that is raised.
  • percentComplete
    Тип: System. . :: . .Int32
    An integer used to indicate how much of the task has completed.
  • progressCountLow
    Тип: System. . :: . .Int32
    An integer that contains the low 32-bits of the units completed.
  • progressCountHigh
    Тип: System. . :: . .Int32
    An integer that contains the high 32-bits of the units completed.
  • fireAgain
    Тип: System. . :: . .Boolean%
    A Boolean that indicates this should continue firing or stop firing. A value of true indicates that it should continue firing.

Замечания

Called any time a task experiences measurable progress. 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 about the progress of a particular task.