TransferJobsTask.Execute Method

Article
12/03/2008

Runs the task.

Namespace: Microsoft.SqlServer.Dts.Tasks.TransferJobsTask
Assembly: Microsoft.SqlServer.TransferJobsTask (in microsoft.sqlserver.transferjobstask.dll)

Syntax

'Declaration
Public Overrides Function Execute ( _
    connections As Connections, _
    variableDispenser As VariableDispenser, _
    events As IDTSComponentEvents, _
    log As IDTSLogging, _
    transaction As Object _
) As DTSExecResult

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

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

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

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

Parameters

connections
A collection of connections used by the task.

variableDispenser
A VariableDispenser object for locking variables.

events
An object that implements the IDTSComponentEvents interface.

log
An object that implements the IDTSLogging interface.

transaction
The transaction object that the container is a part of. This value can be null.

Return Value

A value from the DTSExecResult enumeration.

Remarks

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 run-time 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 Implementing the Execute Method in Custom Integration Services Tasks.

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 support transactions but is not going to participate.

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