TransferLoginsTask.Execute Method (Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object)

  • Article

 

Applies To: SQL Server 2016 Preview

Runs the task.

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

Syntax

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

override Execute : 
        connections:Connections *
        variableDispenser:VariableDispenser *
        events:IDTSComponentEvents *
        log:IDTSLogging *
        transaction:Object -> DTSExecResult

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

Parameters

  • transaction
    Type: System.Object

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

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 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.

See Also

TransferLoginsTask Class
Microsoft.SqlServer.Dts.Tasks.TransferLoginsTask Namespace

Return to top