DefaultEvents.OnProgress 方法

定义

每当任务遇到可度量的进度时调用此方法。

public:
 virtual void OnProgress(Microsoft::SqlServer::Dts::Runtime::TaskHost ^ taskHost, System::String ^ progressDescription, int percentComplete, int progressCountLow, int progressCountHigh, System::String ^ subComponent, bool % fireAgain);
public virtual void OnProgress (Microsoft.SqlServer.Dts.Runtime.TaskHost taskHost, string progressDescription, int percentComplete, int progressCountLow, int progressCountHigh, string subComponent, ref bool fireAgain);
abstract member OnProgress : Microsoft.SqlServer.Dts.Runtime.TaskHost * string * int * int * int * string * bool -> unit
override this.OnProgress : Microsoft.SqlServer.Dts.Runtime.TaskHost * string * int * int * int * string * bool -> unit
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)

参数

taskHost
TaskHost

Null 值。

progressDescription
String

一个说明所引发的事件的进度的字符串。

percentComplete
Int32

一个整数,该整数用于指示完成任务的量。

progressCountLow
Int32

一个整数,该整数包含所完成的单元的低 32 位。

progressCountHigh
Int32

一个整数,该整数包含所完成的单元的高 32 位。

subComponent
String

一个包含有关事件源的详细信息的字符串。

fireAgain
Boolean

一个布尔值,指示这是否应继续触发或停止触发。 true 值指示它应继续触发。

实现

注解

每个任务都有自己的要求,但作为一般规则,任务按增量报告进度为 1%。 OnProgress 由任务在预先确定的时间间隔调用,以更新侦听客户端在特定任务的进度。

适用于