DefaultEvents.OnProgress メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
このメソッドは、タスクがある程度進行すると呼び出されます。
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 -> unitPublic 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 は、特定のタスクの進行状況をリッスンしているクライアントを更新するために、事前に設定された間隔でタスクによって呼び出されます。