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 вызывается задачей с заранее определёнными интервалами для обновления прослушивающих клиентов о ходе выполнения конкретной задачи.