IDTSEvents.OnProgress Method

  • [アーティクル]

タスクの実行に関する進行状況を更新するために呼び出されます。

名前空間: Microsoft.SqlServer.Dts.Runtime
アセンブリ: Microsoft.SqlServer.ManagedDTS (microsoft.sqlserver.manageddts.dll 内)

構文

'宣言
Sub OnProgress ( _
    taskHost As TaskHost, _
    progressDescription As String, _
    percentComplete As Integer, _
    progressCountLow As Integer, _
    progressCountHigh As Integer, _
    subComponent As String, _
    ByRef fireAgain As Boolean _
)

void OnProgress (
    TaskHost taskHost,
    string progressDescription,
    int percentComplete,
    int progressCountLow,
    int progressCountHigh,
    string subComponent,
    ref bool fireAgain
)

void OnProgress (
    TaskHost^ taskHost, 
    String^ progressDescription, 
    int percentComplete, 
    int progressCountLow, 
    int progressCountHigh, 
    String^ subComponent, 
    bool% fireAgain
)

void OnProgress (
    TaskHost taskHost, 
    String progressDescription, 
    int percentComplete, 
    int progressCountLow, 
    int progressCountHigh, 
    String subComponent, 
    /** @ref */ boolean fireAgain
)

JScript は、値と型の引数の参照渡しをサポートしていません。

パラメータ

  • taskHost
    null 値です。
  • progressDescription
    生成される進行状況イベントを説明する文字列です。
  • percentComplete
    タスクがどれだけ完了したかを示すのに使用される整数です。
  • progressCountLow
    完了した単位の下位 32 ビットを含む整数です。
  • progressCountHigh
    完了した単位の上位 32 ビットを含む整数です。
  • subComponent
    イベント ソースについての詳細を含む文字列です。
  • fireAgain
    起動処理を続行するか停止するかを示す Boolean です。値が true の場合、起動処理が続行されます。

解説

タスクがある程度進行すると呼び出されます。各タスクに独自の要件がありますが、一般的に、タスクは 1% 単位で進行状況をレポートします。OnProgress は、事前に決定された間隔でタスクにより呼び出され、受信待ちクライアントの特定のタスクの進行状況を更新します。

スレッド セーフ

この型の public static (Microsoft Visual Basic では共有 ) メンバは、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。

プラットフォーム

開発プラットフォーム

サポートされているプラットフォームの一覧については、「SQL Server 2005 のインストールに必要なハードウェアおよびソフトウェア」を参照してください。

対象プラットフォーム

サポートされているプラットフォームの一覧については、「SQL Server 2005 のインストールに必要なハードウェアおよびソフトウェア」を参照してください。

参照

関連項目

IDTSEvents Interface
IDTSEvents Members
Microsoft.SqlServer.Dts.Runtime Namespace