ExpressionTask Class

  • Article

Contains the members used to configure and run an Expression task.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Dts.Runtime.DtsObject
    Microsoft.SqlServer.Dts.Runtime.Task
      Microsoft.SqlServer.Dts.Tasks.ExpressionTask.ExpressionTask

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

Syntax

'Declaration
<GuidAttribute("2EE7D9A9-DA39-4F6F-A1E4-804F1FBC544C")> _
Public Class ExpressionTask _
    Inherits Task _
    Implements IDTSBreakpointSite, IDTSSuspend, IDTSComponentPersist
'Usage
Dim instance As ExpressionTask

[GuidAttribute("2EE7D9A9-DA39-4F6F-A1E4-804F1FBC544C")]
public class ExpressionTask : Task, 
    IDTSBreakpointSite, IDTSSuspend, IDTSComponentPersist

[GuidAttribute(L"2EE7D9A9-DA39-4F6F-A1E4-804F1FBC544C")]
public ref class ExpressionTask : public Task, 
    IDTSBreakpointSite, IDTSSuspend, IDTSComponentPersist

[<GuidAttribute("2EE7D9A9-DA39-4F6F-A1E4-804F1FBC544C")>]
type ExpressionTask =  
    class 
        inherit Task 
        interface IDTSBreakpointSite 
        interface IDTSSuspend 
        interface IDTSComponentPersist 
    end

public class ExpressionTask extends Task implements IDTSBreakpointSite, IDTSSuspend, IDTSComponentPersist

The ExpressionTask type exposes the following members.

Constructors

  Name Description
Public method ExpressionTask Initializes a new instance of the ExpressionTask class.

Top

Properties

  Name Description
Public property DebugMode Gets or sets a Boolean that indicates whether a task should determine whether breakpoints are enabled.
Public property ExecutionValue Returns the result of the task execution. (Overrides Task.ExecutionValue.)
Public property Expression Gets or sets the expression to be executed by the task.
Public property SuspendRequired Gets or sets a Boolean that indicates whether tasks should suspend when they encounter a breakpoint. This value is set by the runtime engine for tasks and containers when a breakpoint is encountered.
Public property Version *** Member deprecated; see Remarks. ***    Returns the version of the task. This property is read-only. (Inherited from Task.)

Top

Methods

  Name Description
Public method AcceptBreakpointManager Called by the run-time engine when a task or container is created, and is passed a BreakpointManager to enable the task to create, remove, and check the status of breakpoints. This method is called by the runtime and is not used in code.
Public method CanUpdate *** Member deprecated; see Remarks. ***    A Boolean that indicates whether the new package XML can update the old package XML. (Inherited from Task.)
Public method Equals Determines whether two object instances are equal. (Inherited from DtsObject.)
Public method Execute Runs the task. (Overrides Task.Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object).)
Protected method Finalize (Inherited from Object.)
Public method GetConnectionID Gets a String containing the ID of the connection. (Inherited from Task.)
Public method GetConnectionName Gets a String containing the name of the connection. (Inherited from Task.)
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. (Inherited from Task.)
Public method LoadFromXML Loads the definition of the task, in XML format, from the XML definition of the package.
Protected method MemberwiseClone (Inherited from Object.)
Public method ResumeExecution Resumes execution of the task after pausing. The task or container is resumed by the runtime engine.
Public method SaveToXML Saves the definition of the task, in XML format, into the XML definition of the package.
Public method SuspendExecution Indicates that the executable needs to suspend. This method is called by the runtime engine.
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. (Inherited from Task.)
Public method Validate Verifies that the task is properly configured. (Overrides Task.Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging).)
Public method ValidateExpression Verifies that the expression is properly configured.

Top

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.

See Also

Reference

Microsoft.SqlServer.Dts.Tasks.ExpressionTask Namespace