Execute Method

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


Runs the task.

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

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


Type: Microsoft.SqlServer.Dts.Runtime.Connections

A Connections collection for the task.

Type: Microsoft.SqlServer.Dts.Runtime.VariableDispenser

A Variables collection for the task.

Type: Microsoft.SqlServer.Dts.Runtime.IDTSComponentEvents

A reference to an object that implements the IDTSComponentEvents interface for raising events.

Type: Microsoft.SqlServer.Dts.Runtime.IDTSLogging

A reference to an object that implements IDTSLogging.

Type: System.Object

The transaction object that the task is part of, depending on the value found in the TransactionOption property. This value can be set to a null reference (Nothing in Visual Basic).

Return Value

Type: Microsoft.SqlServer.Dts.Runtime.DTSExecResult

A DTSExecResult that indicates the outcome of the execution.

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.

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.

            ' Review the results of the run.
            If taskH.ExecutionResult = DTSExecResult.Failure Or taskH.ExecutionStatus = DTSExecStatus.Abend Then
                Console.WriteLine("Task failed or abended")
                Console.WriteLine("Task ran successfully")
            End If
        End Sub
    End Class
End Namespace
Return to top
© 2015 Microsoft