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


Метод DefaultEvents.OnProgress

This method is called anytime a task experiences measurable progress.

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

Синтаксис

'Декларация
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 _
)
'Применение
Dim instance As DefaultEvents 
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 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
)
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 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 of the 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.
  • subComponent
    Тип: System.String
    A string that contains more detail about the event source.
  • fireAgain
    Тип: System.Boolean%
    A Boolean that indicates whether this should continue firing or stop firing. A value of true indicates that it should continue firing.

Реализует

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

Замечания

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.

См. также

Справочник

DefaultEvents Класс

Пространство имен Microsoft.SqlServer.Dts.Runtime