Share via

  • Article

SendMailTask.AcceptBreakpointManager Method

Passes a BreakpointManager to the Send Mail task. This method is called by the runtime and is not used in code.

Namespace:  Microsoft.SqlServer.Dts.Tasks.SendMailTask
Assembly:  Microsoft.SqlServer.SendMailTask (in Microsoft.SqlServer.SendMailTask.dll)

Syntax

'Declaration
Public Sub AcceptBreakpointManager ( _
    breakPointMgr As BreakpointManager _
)
'Usage
Dim instance As SendMailTask
Dim breakPointMgr As BreakpointManager

instance.AcceptBreakpointManager(breakPointMgr)

public void AcceptBreakpointManager(
    BreakpointManager breakPointMgr
)

public:
virtual void AcceptBreakpointManager(
    BreakpointManager^ breakPointMgr
) sealed

abstract AcceptBreakpointManager : 
        breakPointMgr:BreakpointManager -> unit 
override AcceptBreakpointManager : 
        breakPointMgr:BreakpointManager -> unit 

public final function AcceptBreakpointManager(
    breakPointMgr : BreakpointManager
)

Parameters

Implements

IDTSBreakpointSite.AcceptBreakpointManager(BreakpointManager)

Remarks

The SendMailTask class uses the BreakpointManager to create, remove, and check the status of breakpoints. Tasks store the BreakpointManager locally for use during their Validate and Execute methods.

Examples

This method is overridden when you create a custom task.

The IDTSBreakpointSite interface defines this method, which is inherited by tasks and called by the runtime engine during task creation. The method takes the BreakpointManager object as a parameter, which is then used by each task to create and manage its breakpoints.

The following sample code demonstrates how to override the method when writing a custom task, creating a breakpoint using the BreakpointManager and calling the OnBreakpointHit method to raise the event. For more information, see Adding Support for Debugging in a Custom Task.

public void AcceptBreakpointManager( BreakpointManager breakPointManager )
{
   // Store the breakpoint manager locally.
   this.bpm  = breakPointManager;
   // Create a breakpoint.
   this.bpm.CreateBreakPoint( 1 , "A sample breakpoint." );
}
public override DTSExecResult Execute( Connections connections, Variables variables, IDTSComponentEvents events, IDTSLogging log, DtsTransaction txn)
{
   if( this.bpm.IsBreakpointTargetEnabled( 1 ) == true )
      events.OnBreakpointHit( this.bpm.GetBreakpointTarget( 1 ) );
}

Public  Sub AcceptBreakpointManager(ByVal breakPointManager As BreakpointManager)
   ' Store the breakpoint manager locally.
   Me.bpm  = breakPointManager
   ' Create a breakpoint.
   Me.bpm.CreateBreakPoint(1 , "A sample breakpoint.")
End Sub
Public Overrides Function Execute(ByVal connections As Connections, ByVal variables As Variables, ByVal events As IDTSComponentEvents, ByVal log As IDTSLogging, ByVal txn As DtsTransaction) As DTSExecResult
   If Me.bpm.IsBreakpointTargetEnabled(1) = True Then
      events.OnBreakpointHit(Me.bpm.GetBreakpointTarget(1))
   End If
End Function