BreakpointManager.CreateBreakpointTarget Method

Article
12/03/2008

Creates a new breakpoint in the task with the specified breakpoint ID and description.

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

Syntax

'Declaration
Public Function CreateBreakpointTarget ( _
    breakpointID As Integer, _
    description As String _
) As BreakpointTarget

public BreakpointTarget CreateBreakpointTarget (
    int breakpointID,
    string description
)

public:
BreakpointTarget^ CreateBreakpointTarget (
    int breakpointID, 
    String^ description
)

public BreakpointTarget CreateBreakpointTarget (
    int breakpointID, 
    String description
)

public function CreateBreakpointTarget (
    breakpointID : int, 
    description : String
) : BreakpointTarget

Parameters

breakpointID
The ID to assign to the breakpoint to distinguish it from other breakpoints.

description
A string describing the breakpoint.

Return Value

A BreakpointTarget object.

Remarks

Tasks create breakpoints by calling the CreateBreakpointTarget method and providing integer breakpointID and string description parameters. When a task reaches the point in its code that contains a breakpoint, it evaluates the breakpoint by using IsBreakpointTargetEnabled to determine if the breakpoint is enabled. If true, the task notifies the Data Transformation Run-time engine by raising the OnBreakpointHit event.

Example

The following code example shows the code that creates a breakpoint in a custom task. The variable manager is the breakpoint manager for the task.

manager.CreateBreakpointTarget(BPID1, "My Sample Task Breakpoint #1");

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