XMLTask.SuspendExecution メソッド

定義

名前空間:

Microsoft.SqlServer.Dts.Tasks.XMLTask

アセンブリ:

Microsoft.SqlServer.XMLTask.dll

実行可能ファイルを中断する必要があることを示します。 このメソッドはランタイム エンジンから呼び出されます。

public:
 virtual void SuspendExecution();

public void SuspendExecution ();

abstract member SuspendExecution : unit -> unit
override this.SuspendExecution : unit -> unit

Public Sub SuspendExecution ()

実装

SuspendExecution()

例

次のコードは、カスタム タスクのオーバーライドされた SuspendExecution メソッドの例です。

public void SuspendExecution()   
{  
    lock (this)   
    {  
        // If a suspend is required, do it.   
        if (m_suspendRequired != 0)   
           ChangeEvent(m_canExecute, false);   
        }   

        // The application cannot return from Suspend until the task  
        // is suspended.  
        // This can happen in one of two ways:  
        // 1) The m_suspended event occurs, indicating that the   
        // execute thread has suspended, or   
        // 2) the canExecute flag is set, indicating that a suspend is  
        // no longer required.   
        WaitHandle [] suspendOperationComplete = {m_suspended, m_canExecute};  
        WaitHandle.WaitAny(suspendOperationComplete);  
}  

Public  Sub SuspendExecution()  
    lock (Me)  
    {  
        If m_suspendRequired <> 0 Then  
           ChangeEvent(m_canExecute, False)  
        End If  
    }  
        ' The application cannot return from Suspend until the task  
        ' is suspended. This can happen in one of two ways:  
        ' 1) The m_suspended event occurs, indicating that the   
        ' execute thread has suspended, or   
        ' 2) the canExecute flag is set, indicating that a suspend is  
        ' no longer required.   
        Dim suspendOperationComplete As WaitHandle() = {m_suspended, m_canExecute}  
        WaitHandle.WaitAny(suspendOperationComplete)  

注釈

このメソッドは、XMLTask の値に関係なく、OperationType に対して利用できます。

このメソッドはコードでは使用されません。 ブレークポイントに到達したときにランタイムから呼び出されます。

ただし、ブレークポイントを公開するマルチスレッド カスタム タスクを作成する場合は、IDTSSuspend クラスから継承されるこのメソッドのコードを指定する必要があります。 タスクがシングル スレッドである場合は、カスタム タスクの実装 Execute で新しいスレッドが開始されないことを意味します。このインターフェイスを実装する必要はありません。 カスタム タスクの記述の詳細については、「カスタム タスク の開発」を参照してください。