Task Class

Article
04/26/2013

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
	Task	Initializes a new instance of the Task class.

Top

Properties

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

Top

Methods

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

Share via

Task Class

Inheritance Hierarchy

Syntax

Constructors

Properties

Methods

Remarks

Examples

Thread Safety

See Also

Reference

Inheritance Hierarchy

Additional resources