DefaultEvents.OnProgress メソッド
このメソッドは、タスクがある程度進行すると呼び出されます。
名前空間: 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
)
パラメーター
- taskHost
型: Microsoft.SqlServer.Dts.Runtime.TaskHost
nullNULL 参照 (Visual Basic では Nothing) 値です。
- progressDescription
型: System.String
発生するイベントの進行状況を説明する文字列です。
- percentComplete
型: System.Int32
タスクがどれだけ完了したかを示すのに使用される整数です。
- progressCountLow
型: System.Int32
完了した単位の下位 32 ビットを含む整数です。
- progressCountHigh
型: System.Int32
完了した単位の上位 32 ビットを含む整数です。
- subComponent
型: System.String
イベント ソースについての詳細を含む文字列です。
- fireAgain
型: System.Boolean%
起動処理を続行するか停止するかを示す Boolean です。 値が true の場合、起動処理が続行されます。
実装
IDTSEvents.OnProgress(TaskHost, String, Int32, Int32, Int32, String, Boolean%)
説明
各タスクに独自の要件がありますが、一般的に、タスクは 1% 単位で進行状況をレポートします。 OnProgress は、事前に決定された間隔でタスクにより呼び出され、受信待ちクライアントの特定のタスクの進行状況を更新します。