ScriptTask.DebugMode Property

Gets or sets a value indicating whether the task is running in debug mode, and whether it should raise the OnBreakpointHit event while the task is running.

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

Syntax

'Declaration
Public Property DebugMode As Boolean
    Get
    Set
'Usage
Dim instance As ScriptTask
Dim value As Boolean

value = instance.DebugMode

instance.DebugMode = value

public bool DebugMode { get; set; }

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

abstract DebugMode : bool with get, set
override DebugMode : bool with get, set

final function get DebugMode () : boolean
final function set DebugMode (value : boolean)

Property Value

Type: System.Boolean
true if the object is in debug mode and raises the OnBreakpointHit event; otherwise, false.

Implements

IDTSBreakpointSite.DebugMode

Remarks

The IsBreakpointTargetEnabled function is called every time that the task encounters a breakpoint in its code. Because calling the function IsBreakpointTargetEnabled to see whether the breakpoint target is enabled is expensive when it is called repeatedly, the DebugMode flag is used to indicate whether the executable is to be debugged. When this flag is set to false, the task can avoid the call to check for an enabled breakpoint. A value of true indicates that the task should check for enabled breakpoints. When true, the value of IsBreakpointTargetEnabled is checked.

See Also

Reference

ScriptTask Class

Microsoft.SqlServer.Dts.Tasks.ScriptTask Namespace