Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

Task Class

 

Applies To: SQL Server 2016 Preview

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

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

System.Object
  Microsoft.SqlServer.Dts.Runtime.DtsObject
    Microsoft.SqlServer.Dts.Runtime.Task
      Microsoft.DataTransformationServices.Tasks.DTSProcessingTask.ASTaskBase
      Microsoft.SqlServer.Dts.Tasks.BulkInsertTask.BulkInsertTask
      Microsoft.SqlServer.Dts.Tasks.DataProfilingTask.DataProfilingTask
      Microsoft.SqlServer.Dts.Tasks.DMQueryTask.DMQueryTask
      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

public abstract class Task : DtsObject, IDTSManagedTask

NameDescription
System_CAPS_protmethodTask()

Initializes a new instance of the Task class.

NameDescription
System_CAPS_pubpropertyExecutionValue

Returns a user-defined object. This field is read-only.

System_CAPS_pubpropertyVersion

*** Member deprecated; see Remarks. ***   Returns the version of the task. This property is read-only.

NameDescription
System_CAPS_pubmethodCanUpdate(String)

*** Member deprecated; see Remarks. ***   A Boolean that indicates whether the new package XML can update the old package XML.

System_CAPS_pubmethodEquals(Object)

Determines whether two object instances are equal.(Inherited from DtsObject.)

System_CAPS_pubmethodExecute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object)

Runs the task.

System_CAPS_protmethodFinalize()

(Inherited from Object.)

System_CAPS_pubmethodGetConnectionID(Connections, String)

Gets a String containing the ID of the connection.

System_CAPS_pubmethodGetConnectionName(Connections, String)

Gets a String containing the name of the connection.

System_CAPS_pubmethodGetHashCode()

Returns the hash code for this instance.(Inherited from DtsObject.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodInitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker)

Initializes the properties associated with the task. This method is called by the runtime and is not used in code.

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethodToString()

(Inherited from Object.)

System_CAPS_pubmethodUpdate(String)

*** Member deprecated; see Remarks. ***   This method updates the old package XML with the new package XML if CanUpdate is set to true.

System_CAPS_pubmethodValidate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging)

Verifies that the component is properly configured.

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.

Legacy Code Example

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;
    }
}

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

Return to top

Community Additions

Show:
© 2015 Microsoft