DTSExecResult Enumeration (Microsoft.SqlServer.Dts.Runtime)

DTSExecResult Enumeration

Provides values that describe the result of a task execution.

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

Syntax

VisualBasicDeclaration

Public Enumeration DTSExecResult

CSharp

public enum DTSExecResult

ManagedCPlusPlus

public enum class DTSExecResult

JSharp

public enum DTSExecResult

JScript

public enum DTSExecResult

Members

Member name	Description
Canceled	The task was cancelled. (Value = 3)
Completion	The task ran to completion. (Value = 2)
Failure	The task failed. (Value = 1)
Success	The task ran successfully. (Value = 0)

Remarks

The run-time engine processes the tasks contained in a package or container by calling their implementation of the Execute method. Tasks implement their core logic and functionality in this method and provide the results of execution by posting messages and returning a value from the DTSExecResult enumeration.

Example

The following code example shows one way of using the DTSExecResult enumeration in a package. The Package class uses this enumeration as a return value to the Execute method to determine the success or failure status of the package.

CSharp

using System;
using System.Collections.Generic;
using System.Text;
using Microsoft.SqlServer.Dts.Runtime;
using Microsoft.SqlServer.Dts.Tasks.ScriptTask;

namespace Package_API
{
    class Program
    {
        static void Main(string[] args)
        {
            Package p = new Package();
            p.InteractiveMode = true;
            p.OfflineMode = true;

            // Add a Script Task to the package.
            TaskHost taskH = (TaskHost)p.Executables.Add("STOCK:ScriptTask");
            // Run the package.
            p.Execute();
            // Review the results of the run.
            if (taskH.ExecutionResult == DTSExecResult.Failure || taskH.ExecutionStatus == DTSExecStatus.Abend)
                Console.WriteLine("Task failed or abended");
            else
                Console.WriteLine("Task ran successfully");
        }
    }
}

VisualBasic

Imports System
Imports System.Collections.Generic
Imports System.Text
Imports Microsoft.SqlServer.Dts.Runtime
Imports Microsoft.SqlServer.Dts.Tasks.ScriptTask
 
Namespace Package_API
    Class Program
        Shared  Sub Main(ByVal args() As String)
            Dim p As Package =  New Package() 
            p.InteractiveMode = True
            p.OfflineMode = True
 
            ' Add a Script Task to the package.
            Dim taskH As TaskHost = CType(p.Executables.Add("STOCK:ScriptTask"), TaskHost)
            ' Run the package.
            p.Execute()
            ' Review the results of the run.
            If taskH.ExecutionResult = DTSExecResult.Failure Or taskH.ExecutionStatus = DTSExecStatus.Abend Then
                Console.WriteLine("Task failed or abended")
            Else 
                Console.WriteLine("Task ran successfully")
            End If
        End Sub
    End Class
End Namespace

Sample Output:

Task ran successfully

Platforms

Development Platforms

Target Platforms

Reference