ScriptTask.SuspendRequired Property

Article
12/03/2008

Gets or sets a Boolean indicating whether a task should suspend execution when the task encounters a breakpoint. This value is set by the run-time engine for tasks and containers when a breakpoint is encountered.

Namespace: Microsoft.SqlServer.Dts.Tasks.ScriptTask
Assembly: Microsoft.SqlServer.ScriptTask (in microsoft.sqlserver.scripttask.dll)

Syntax

'Declaration
Public Property SuspendRequired As Boolean

public bool SuspendRequired { get; set; }

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

/** @property */
public final boolean get_SuspendRequired ()

/** @property */
public final void set_SuspendRequired (boolean value)

public final function get SuspendRequired () : boolean

public final function set SuspendRequired (value : boolean)

Property Value

true if the task suspends execution when it encounters a breakpoint; otherwise, false.

Remarks

This property is not set in code. The property is set by the runtime for tasks and containers when a breakpoint is encountered.

However, if you write a multithreaded custom task that exposes breakpoints, you must provide code for this method, which is inherited from the IDTSSuspend class for multithreaded objects. If your task is single threaded, which means that the implementation of Execute in your custom task does not start new threads, you do not have to implement this interface. For more information about writing custom tasks, see Developing a Custom Task.

Example

The following code example shows how to override the SuspendRequired property for a custom task.

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

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms