ActiveXScriptTask.SuspendRequired Property

Gets or sets a Boolean that indicates whether tasks should suspend when they encounter a breakpoint.

Namespace:  Microsoft.SqlServer.Dts.Tasks.ActiveXScriptTask
Assembly:  Microsoft.SqlServer.ActiveXScriptTask (in Microsoft.SqlServer.ActiveXScriptTask.dll)

Syntax

'Declaration
Public Property SuspendRequired As Boolean
    Get
    Set
'Usage
Dim instance As ActiveXScriptTask
Dim value As Boolean

value = instance.SuspendRequired

instance.SuspendRequired = value
public bool SuspendRequired { get; set; }
public:
virtual property bool SuspendRequired {
    bool get () sealed;
    void set (bool value) sealed;
}
abstract SuspendRequired : bool with get, set
override SuspendRequired : bool with get, set
final function get SuspendRequired () : boolean
final function set SuspendRequired (value : boolean)

Property Value

Type: System.Boolean
true indicates that the task suspends. false indicates that the task does not suspend.

Implements

IDTSSuspend.SuspendRequired

Remarks

When the run-time engine receives an OnBreakpointHit event from a task, it calls the SuspendExecution method for each executing task, notifying the task to pause execution.

Because there may be a significant delay between the time a task first receives a suspend call and the time it can actually suspends, the SuspendRequired property is set to indicate if a suspend action is still required. If this property is set to false, the task can immediately return from the suspend call.

Important

This feature will be removed in the next version of Microsoft SQL Server. Do not use this feature in new development work, and modify applications that currently use this feature as soon as possible.