Partager via

  • Article

CreateBreakpointTarget méthode

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

Espace de noms :  Microsoft.SqlServer.Dts.Runtime
Assembly :  Microsoft.SqlServer.ManagedDTS (dans Microsoft.SqlServer.ManagedDTS.dll)

Syntaxe

'Déclaration
Public Function CreateBreakpointTarget ( _
    breakpointID As Integer, _
    description As String _
) As BreakpointTarget
'Utilisation
Dim instance As BreakpointManager
Dim breakpointID As Integer
Dim description As String
Dim returnValue As BreakpointTarget

returnValue = instance.CreateBreakpointTarget(breakpointID, _
    description)

public BreakpointTarget CreateBreakpointTarget(
    int breakpointID,
    string description
)

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

member CreateBreakpointTarget : 
        breakpointID:int * 
        description:string -> BreakpointTarget 

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

Paramètres

  • breakpointID
    Type : System. . :: . .Int32
    The ID to assign to the breakpoint to distinguish it from other breakpoints.

Notes

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.

Exemples

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