ScriptTask.SuspendRequired Свойство

Определение

Пространство имен:

Microsoft.SqlServer.Dts.Tasks.ScriptTask

Сборка:

Microsoft.SqlServer.ScriptTask.dll

Возвращает или задает логическое значение, указывающее, должна ли задача приостановить выполнение при обнаружении точки останова. Это значение устанавливается подсистемой среды выполнения для задач и контейнеров при обнаружении точки останова.

public:
 property bool SuspendRequired { bool get(); void set(bool value); };

public bool SuspendRequired { get; set; }

member this.SuspendRequired : bool with get, set

Public Property SuspendRequired As Boolean

Значение свойства

Boolean

Значение true, если задача приостанавливает выполнение при обнаружении точки останова; в противном случае — значение false.

Реализации

SuspendRequired

Примеры

В следующем примере кода показано, как переопределить SuspendRequired свойство для пользовательской задачи.

public bool SuspendRequired   
{  
     get  
    {   
        // m_suspendRequired is a Private integer declared in the custom task.   
        return m_suspendRequired != 0;   
    }  

    set  
    {  
    // This lock is also taken by Suspend().  Because it is possible for the package to be   
    // suspended and resumed in quick succession, this property "set" might happen   
    // before the actual Suspend() call.  Without the lock, the Suspend() might reset   
    // the canExecute event after we set it to abort the suspension.   
         lock (this)   
    {  
        Interlocked.Exchange(ref m_suspendRequired, value ? 1 : 0);   
            if (!value)   
                ResumeExecution();   
    }  
}  

Public ReadOnly Property SuspendRequired() As Boolean  
    Get   
        ' m_suspendRequired is a Private integer declared in the custom task.   
        Return m_suspendRequired <> 0  
     End Get  

Public WriteOnly Property SuspendRequired() As Boolean  
    Set (ByVal Value As Boolean)   
        ' This lock is also taken by Suspend().  Because it is possible for the package to be   
        ' suspended and resumed in quick succession, this property "put" might happen   
       ' before the actual Suspend() call.  Without the lock, the Suspend() might reset  
       ' the canExecute event after we set it to abort the suspension.   
         lock (Me)  
         {  
               Interlocked.Exchange(m_suspendRequired, value ? 1 : 0)   
                     If Not value Then  
                       ResumeExecution()  
                     End If  
             }  
         End Set  
End Property  

Комментарии

Это свойство не задано в коде. Свойство задается средой выполнения для задач и контейнеров при обнаружении точки останова.

Однако при написании многопоточной пользовательской задачи, которая предоставляет точки останова, необходимо предоставить код для этого метода, который наследуется от IDTSSuspend класса для многопоточных объектов. Если задача состоит из одного потока, то есть реализация Execute в пользовательской задаче не запускает новые потоки, вам не нужно реализовывать этот интерфейс. Дополнительные сведения о написании пользовательских задач см. в разделе "Разработка пользовательской задачи".