BreakpointManager.GetBreakpointTarget Method

Returns the breakpoint object for a specific breakpoint ID.

Namespace:  Microsoft.SqlServer.Dts.Runtime
Assembly:  Microsoft.SqlServer.ManagedDTS (in Microsoft.SqlServer.ManagedDTS.dll)

Syntax

'Declaration
Public Function GetBreakpointTarget ( _
    breakpointID As Integer _
) As BreakpointTarget
'Usage
Dim instance As BreakpointManager 
Dim breakpointID As Integer 
Dim returnValue As BreakpointTarget 

returnValue = instance.GetBreakpointTarget(breakpointID)
public BreakpointTarget GetBreakpointTarget(
    int breakpointID
)
public:
BreakpointTarget^ GetBreakpointTarget(
    int breakpointID
)
member GetBreakpointTarget : 
        breakpointID:int -> BreakpointTarget
public function GetBreakpointTarget(
    breakpointID : int
) : BreakpointTarget

Parameters

  • breakpointID
    Type: System.Int32
    The ID of the breakpoint to return.

Return Value

Type: Microsoft.SqlServer.Dts.Runtime.BreakpointTarget
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

See Also

Reference

BreakpointManager Class

Microsoft.SqlServer.Dts.Runtime Namespace