BreakpointManager.IsBreakpointTargetEnabled(Int32) Method

Reference

Definition

Namespace:: Microsoft.SqlServer.Dts.Runtime

Assembly:: Microsoft.SqlServer.ManagedDTS.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

A Boolean that indicates if the breakpoint is enabled.

public:
 bool IsBreakpointTargetEnabled(int breakpointID);

public bool IsBreakpointTargetEnabled (int breakpointID);

member this.IsBreakpointTargetEnabled : int -> bool

Public Function IsBreakpointTargetEnabled (breakpointID As Integer) As Boolean

Parameters

breakpointID: Int32

The ID of the breakpoint that you want to verify if it is enabled or not.

Returns

Boolean

A Boolean that indicates if the breakpoint is enabled. A value of true indicates that a previously created breakpoint has been enabled by the client task.

Examples

The following example shows a custom task checking for a breakpoint after verifying that the breakpoint target is enabled. This code is in the custom task's Execute method, where the variable, bpm, is the breakpoint manager for the task.

if( this.bpm.IsBreakpointTargetEnabled( 1 ) == true )  
      events.OnBreakpointHit( this.bpm.GetBreakpointTarget( 1 ) );

If Me.bpm.IsBreakpointTargetEnabled(1) = True Then  
      events.OnBreakpointHit(Me.bpm.GetBreakpointTarget(1))  
End If

Remarks

If true, the task notifies the Data Transformation Run-time engine by raising the OnBreakpointHit event.

Applies to