SendMailTask::Execute Method (Connections^, VariableDispenser^, IDTSComponentEvents^, IDTSLogging^, Object^)

 

Executes the Send Mail task.

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

public:
virtual DTSExecResult Execute(
	Connections^ connections,
	VariableDispenser^ variableDispenser,
	IDTSComponentEvents^ events,
	IDTSLogging^ log,
	Object^ transaction
) override

Parameters

connections
Type: Microsoft.SqlServer.Dts.Runtime::Connections^

A collection of connections used by the task.

variableDispenser
Type: Microsoft.SqlServer.Dts.Runtime::VariableDispenser^

A object for locking variables.

events
Type: Microsoft.SqlServer.Dts.Runtime::IDTSComponentEvents^

An T:Microsoft.SqlServer.Dts.Runtime.IDTSEvents interface to raise events.

log
Type: Microsoft.SqlServer.Dts.Runtime::IDTSLogging^

An T:Microsoft.SqlServer.Dts.Runtime.IDTSLogging interface.

transaction
Type: System::Object^

The transaction to which the container belongs. The SSIS Runtime provides the transaction for the container, based on the P:Microsoft.SqlServer.Dts.Runtime.DtsContainer.TransactionOption property. This value can be null.

The Execute method is inherited by task hosts and other objects from the Executable abstract class, through the DtsContainer class, and allows the inheriting objects to be run by the runtime engine. The Execute method inherited by the individual objects is not commonly used in code, and it is recommended that you call the Execute method if you need to run any of the tasks or containers in the package. However, the Execute method is available on individual objects should you find a unique circumstance where it is needed.

The main use of the Execute method is for it to be inherited and overridden when you create a custom task. For more information about how to override the Execute method, see Coding a Custom Task.

The Execute method calls the Validate method implicitly before the package runs. All tasks in the package are reviewed for appropriate settings during validation, and all objects in the package are reviewed, including the package, containers, and other components in the package.

If there are no problems encountered in the validation phase that would cause the package to fail, the package object proceeds to call the Execute method for each task and object in the package.

Pass null for the transaction parameter when the TransactionOption property is false. If the TransactionOption property is true, you can pass null in the transaction parameter to indicate that the container supports transactions but does not participate.

The following code example shows how to run a package containing a BulkInsertTask after some of the task properties are set. The Bulk Insert task is an example for this code sample; any task can be created in its place.

No code example is currently available or this language may not be supported.
Return to top
Show: