Task Class

Defines an abstract class that implements the methods and properties common to all tasks in Integration Services. 

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Dts.Runtime.DtsObject
    Microsoft.SqlServer.Dts.Runtime.Task
      More...

Namespace:  Microsoft.SqlServer.Dts.Runtime
Assembly:  Microsoft.SqlServer.ManagedDTS (in Microsoft.SqlServer.ManagedDTS.dll)

Syntax

'Declaration
Public MustInherit Class Task _
    Inherits DtsObject _
    Implements IDTSManagedTask
'Usage
Dim instance As Task
public abstract class Task : DtsObject, 
    IDTSManagedTask
public ref class Task abstract : public DtsObject, 
    IDTSManagedTask
[<AbstractClassAttribute>]
type Task =  
    class
        inherit DtsObject
        interface IDTSManagedTask
    end
public abstract class Task extends DtsObject implements IDTSManagedTask

The Task type exposes the following members.

Constructors

  Name Description
Protected method Task Initializes a new instance of the Task class.

Top

Properties

  Name Description
Public property ExecutionValue Returns a user-defined object. This field is read-only.
Public property Version *** Member deprecated; see Remarks. ***    Returns the version of the task. This property is read-only.

Top

Methods

  Name Description
Public method CanUpdate *** Member deprecated; see Remarks. ***    A Boolean that indicates whether the new package XML can update the old package XML.
Public method Equals Determines whether two object instances are equal. (Inherited from DtsObject.)
Public method Execute Runs the task.
Protected method Finalize (Inherited from Object.)
Public method GetConnectionID Gets a String containing the ID of the connection.
Public method GetConnectionName Gets a String containing the name of the connection.
Public method GetHashCode Returns the hash code for this instance. (Inherited from DtsObject.)
Public method GetType (Inherited from Object.)
Public method InitializeTask Initializes the properties associated with the task. This method is called by the runtime and is not used in code.
Protected method MemberwiseClone (Inherited from Object.)
Public method ToString (Inherited from Object.)
Public method Update *** Member deprecated; see Remarks. ***    This method updates the old package XML with the new package XML if CanUpdate is set to true.
Public method Validate Verifies that the component is properly configured.

Top

Remarks

A package consists of one or more tasks. These tasks define units of work that are performed as part of copying and transforming data, communicating with other processes, and performing database management functions.

Inherits from DtsObject and IDTSManagedTask.

Examples

The following code example is a very simple task implementation for a custom task that inherits from Task.

using System;
using Microsoft.SqlServer.Dts.Runtime;

class MyTask : Task
{
    private int m_value = 123;

    public override DTExecResult Execute(Connections connections,
Variables variables, IDTSEvents events,
IDTSLogging log, int lastExecResult, DtsTransaction txn)
    {
        return m_value;
    }
}
Imports System
Imports Microsoft.SqlServer.Dts.Runtime
 
Class MyTask
    Inherits Task
    Private m_value As Integer =  123 
    Public Overrides DTExecResult Property connections,() As Execute(Connections
    End Property
Variables variables, IDTSEvents events,
IDTSLogging log,int Function txn)() As lastExecResult,DtsTransaction
        Return m_value
End Function
End Class

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Dts.Runtime.DtsObject
    Microsoft.SqlServer.Dts.Runtime.Task
      Microsoft.DataTransformationServices.Tasks.DTSProcessingTask.ASTaskBase
      Microsoft.SqlServer.Dts.Tasks.ActiveXScriptTask.ActiveXScriptTask
      Microsoft.SqlServer.Dts.Tasks.BulkInsertTask.BulkInsertTask
      Microsoft.SqlServer.Dts.Tasks.DataProfilingTask.DataProfilingTask
      Microsoft.SqlServer.Dts.Tasks.DMQueryTask.DMQueryTask
      Microsoft.SqlServer.Dts.Tasks.Exec80PackageTask.Exec80PackageTask
      Microsoft.SqlServer.Dts.Tasks.ExecuteProcess.ExecuteProcess
      Microsoft.SqlServer.Dts.Tasks.ExecuteSQLTask.ExecuteSQLTask
      Microsoft.SqlServer.Dts.Tasks.FileSystemTask.FileSystemTask
      Microsoft.SqlServer.Dts.Tasks.FtpTask.FtpTask
      Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTask
      Microsoft.SqlServer.Dts.Tasks.ScriptTask.ScriptTask
      Microsoft.SqlServer.Dts.Tasks.SendMailTask.SendMailTask
      Microsoft.SqlServer.Dts.Tasks.TransferDatabaseTask.TransferDatabaseTask
      Microsoft.SqlServer.Dts.Tasks.TransferErrorMessagesTask.TransferErrorMessagesTask
      Microsoft.SqlServer.Dts.Tasks.TransferJobsTask.TransferJobsTask
      Microsoft.SqlServer.Dts.Tasks.TransferLoginsTask.TransferLoginsTask
      Microsoft.SqlServer.Dts.Tasks.TransferSqlServerObjectsTask.TransferSqlServerObjectsTask
      Microsoft.SqlServer.Dts.Tasks.TransferStoredProceduresTask.TransferStoredProceduresTask
      Microsoft.SqlServer.Dts.Tasks.WebServiceTask.WebServiceTask
      Microsoft.SqlServer.Dts.Tasks.WmiDataReaderTask.WmiDataReaderTask
      Microsoft.SqlServer.Dts.Tasks.WmiEventWatcherTask.WmiEventWatcherTask
      Microsoft.SqlServer.Dts.Tasks.XMLTask.XMLTask