BreakpointManager.IsBreakpointTargetEnabled Method
A Boolean that indicates if the breakpoint is enabled.
Namespace: Microsoft.SqlServer.Dts.Runtime
Assembly: Microsoft.SqlServer.ManagedDTS (in Microsoft.SqlServer.ManagedDTS.dll)
Syntax
'Declaration
Public Function IsBreakpointTargetEnabled ( _
breakpointID As Integer _
) As Boolean
'Usage
Dim instance As BreakpointManager
Dim breakpointID As Integer
Dim returnValue As Boolean
returnValue = instance.IsBreakpointTargetEnabled(breakpointID)
public bool IsBreakpointTargetEnabled(
int breakpointID
)
public:
bool IsBreakpointTargetEnabled(
int breakpointID
)
member IsBreakpointTargetEnabled :
breakpointID:int -> bool
public function IsBreakpointTargetEnabled(
breakpointID : int
) : boolean
Parameters
- breakpointID
Type: System.Int32
The ID of the breakpoint that you want to verify if it is enabled or not.
Return Value
Type: System.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.
Remarks
If true, the task notifies the Data Transformation Run-time engine by raising the OnBreakpointHit event.
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