ActiveXScriptTask.SuspendRequired Property

Article
12/03/2008

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

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 indicates that the task suspends. false indicates that the task does not suspend.

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.

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

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

Share via