BreakpointManager.IsBreakpointTargetEnabled Method

Article
12/03/2008

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

public bool IsBreakpointTargetEnabled (
    int breakpointID
)

public:
bool IsBreakpointTargetEnabled (
    int breakpointID
)

public boolean IsBreakpointTargetEnabled (
    int breakpointID
)

public function IsBreakpointTargetEnabled (
    breakpointID : int
) : boolean

Parameters

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

Return Value

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.

Example

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

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