Share via


BreakpointManager.CreateBreakpointTarget(Int32, String) Method

Definition

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

public:
 Microsoft::SqlServer::Dts::Runtime::BreakpointTarget ^ CreateBreakpointTarget(int breakpointID, System::String ^ description);
public Microsoft.SqlServer.Dts.Runtime.BreakpointTarget CreateBreakpointTarget (int breakpointID, string description);
member this.CreateBreakpointTarget : int * string -> Microsoft.SqlServer.Dts.Runtime.BreakpointTarget
Public Function CreateBreakpointTarget (breakpointID As Integer, description As String) As BreakpointTarget

Parameters

breakpointID
Int32

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

description
String

A string describing the breakpoint.

Returns

A BreakpointTarget object.

Examples

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");  

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.

Applies to