Share via


FileSystemTask.DebugMode Property

A Boolean indicating if a task should check if breakpoints are enabled.

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

Syntax

'Declaration
Public Property DebugMode As Boolean
    Get
    Set
'Usage
Dim instance As FileSystemTask
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 task should check for enabled breakpoints; otherwise false.

Implements

IDTSBreakpointSite.DebugMode

Remarks

The IsBreakpointTargetEnabled function is called each time the task encounters a breakpoint in its code. Because calling the function IsBreakpointTargetEnabled to see if the breakpoint target is enabled is expensive when called repeatedly, the DebugMode flag is used to indicate if 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, and calls the IsBreakpointTargetEnabled.