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
public bool DebugMode { get; set; }
public:
virtual property bool DebugMode {
    bool get () sealed;
    void set (bool value) sealed;
}
/** @property */
public final boolean get_DebugMode ()

/** @property */
public final void set_DebugMode (boolean value)
public final function get DebugMode () : boolean

public final function set DebugMode (value : boolean)

Property Value

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

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.

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.

See Also

Reference

ScriptTask Class
ScriptTask Members
Microsoft.SqlServer.Dts.Tasks.ScriptTask Namespace