BreakpointManager.GetBreakpointTarget(Int32) Method

Definition

Returns the breakpoint object for a specific breakpoint ID.

public:
 Microsoft::SqlServer::Dts::Runtime::BreakpointTarget ^ GetBreakpointTarget(int breakpointID);
public Microsoft.SqlServer.Dts.Runtime.BreakpointTarget GetBreakpointTarget (int breakpointID);
member this.GetBreakpointTarget : int -> Microsoft.SqlServer.Dts.Runtime.BreakpointTarget
Public Function GetBreakpointTarget (breakpointID As Integer) As BreakpointTarget

Parameters

breakpointID
Int32

The ID of the breakpoint to return.

Returns

A BreakpointTarget object.

Examples

The following example shows a custom task checking for a breakpoint. 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  

Applies to