BreakpointManager.GetBreakpointTarget Method

Article
12/03/2008

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

public BreakpointTarget GetBreakpointTarget (
    int breakpointID
)

public:
BreakpointTarget^ GetBreakpointTarget (
    int breakpointID
)

public BreakpointTarget GetBreakpointTarget (
    int breakpointID
)

public function GetBreakpointTarget (
    breakpointID : int
) : BreakpointTarget

Parameters

breakpointID
The ID of the breakpoint to return.

Return Value

A BreakpointTarget object.

Example

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

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms