FileSystemTask.Execute Method
Runs the task.
Namespace: Microsoft.SqlServer.Dts.Tasks.FileSystemTask
Assembly: Microsoft.SqlServer.FileSystemTask (in Microsoft.SqlServer.FileSystemTask.dll)
Syntax
'Declaration
Public Overrides Function Execute ( _
connections As Connections, _
variableDispenser As VariableDispenser, _
events As IDTSComponentEvents, _
log As IDTSLogging, _
txn As Object _
) As DTSExecResult
'Usage
Dim instance As FileSystemTask
Dim connections As Connections
Dim variableDispenser As VariableDispenser
Dim events As IDTSComponentEvents
Dim log As IDTSLogging
Dim txn As Object
Dim returnValue As DTSExecResult
returnValue = instance.Execute(connections, _
variableDispenser, events, log, txn)
public override DTSExecResult Execute(
Connections connections,
VariableDispenser variableDispenser,
IDTSComponentEvents events,
IDTSLogging log,
Object txn
)
public:
virtual DTSExecResult Execute(
Connections^ connections,
VariableDispenser^ variableDispenser,
IDTSComponentEvents^ events,
IDTSLogging^ log,
Object^ txn
) override
abstract Execute :
connections:Connections *
variableDispenser:VariableDispenser *
events:IDTSComponentEvents *
log:IDTSLogging *
txn:Object -> DTSExecResult
override Execute :
connections:Connections *
variableDispenser:VariableDispenser *
events:IDTSComponentEvents *
log:IDTSLogging *
txn:Object -> DTSExecResult
public override function Execute(
connections : Connections,
variableDispenser : VariableDispenser,
events : IDTSComponentEvents,
log : IDTSLogging,
txn : 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.
- txn
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 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 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 supports transactions but does not participate.
Examples
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.
using System;
using System.Collections.Generic;
using System.Text;
using Microsoft.SqlServer.Dts.Runtime;
using Microsoft.SqlServer.Dts.Tasks.BulkInsertTask
namespace Microsoft.SqlServer.SSIS.Samples
{
class Program
{
static void Main(string[] args)
{
Package p = new Package();
p.InteractiveMode = true;
p.OfflineMode = true;
Executable exec1 = pkg.Executables.Add("STOCK:BulkInsertTask");
TaskHost th = exec1 as TaskHost;
// Set the CheckConstraints and DataFileType properties.
th.Properties["CheckConstraints"].SetValue(th, true);
th.Properties["DataFileType"].SetValue(th, DTSBulkInsert_DataFileType.DTSBulkInsert_DataFileType_Native);
// Run the package that contains the task.
pkg.Execute();
// Review the results of the run.
if (taskH.ExecutionResult == DTSExecResult.Failure || taskH.ExecutionStatus == DTSExecStatus.Abend)
Console.WriteLine("Task failed or abended");
else
Console.WriteLine("Task ran successfully");
}
}
}
Imports System
Imports System.Collections.Generic
Imports System.Text
Imports Microsoft.SqlServer.Dts.Runtime
Imports Microsoft.SqlServer.Dts.Tasks.BulkInsertTask
Namespace Microsoft.SqlServer.SSIS.Samples
Class Program
Shared Sub Main(ByVal args() As String)
Dim p As Package = New Package()
p.InteractiveMode = True
p.OfflineMode = True
Dim exec1 As Executable = pkg.Executables.Add("STOCK:BulkInsertTask")
Dim th As TaskHost = exec1 as TaskHost
' Set the CheckConstraints and DataFileType properties.
th.Properties("CheckConstraints").SetValue(th, True)
th.Properties("DataFileType").SetValue(th, DTSBulkInsert_DataFileType.DTSBulkInsert_DataFileType_Native)
' Run the package that contains the task.
pkg.Execute()
' Review the results of the run.
If taskH.ExecutionResult = DTSExecResult.Failure Or taskH.ExecutionStatus = DTSExecStatus.Abend Then
Console.WriteLine("Task failed or abended")
Else
Console.WriteLine("Task ran successfully")
End If
End Sub
End Class
End Namespace