TransferJobsTask.Execute Method
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
'Usage
Dim instance As TransferJobsTask
Dim connections As Connections
Dim variableDispenser As VariableDispenser
Dim events As IDTSComponentEvents
Dim log As IDTSLogging
Dim transaction As Object
Dim returnValue As DTSExecResult
returnValue = instance.Execute(connections, _
variableDispenser, events, log, transaction)
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
abstract Execute :
connections:Connections *
variableDispenser:VariableDispenser *
events:IDTSComponentEvents *
log:IDTSLogging *
transaction:Object -> DTSExecResult
override Execute :
connections:Connections *
variableDispenser:VariableDispenser *
events:IDTSComponentEvents *
log:IDTSLogging *
transaction:Object -> DTSExecResult
public override function Execute(
connections : Connections,
variableDispenser : VariableDispenser,
events : IDTSComponentEvents,
log : IDTSLogging,
transaction : Object
) : DTSExecResult
Parameters
- connections
Type: Microsoft.SqlServer.Dts.Runtime.Connections
A collection of connections used by the task.
- variableDispenser
Type: Microsoft.SqlServer.Dts.Runtime.VariableDispenser
A VariableDispenser object for locking variables.
- events
Type: Microsoft.SqlServer.Dts.Runtime.IDTSComponentEvents
An object that implements the IDTSComponentEvents interface.
- log
Type: Microsoft.SqlServer.Dts.Runtime.IDTSLogging
An object that implements the IDTSLogging interface.
- transaction
Type: System.Object
The transaction object that the container is a part of. This value can be nulla null reference (Nothing in Visual Basic).
Return Value
Type: Microsoft.SqlServer.Dts.Runtime.DTSExecResult
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 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 nulla null reference (Nothing in Visual Basic) 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.