DTSExecResult Enum

Definition

Namespace:

Microsoft.SqlServer.Dts.Runtime

Assembly:

Microsoft.SqlServer.ManagedDTS.dll

Provides values that describe the result of a task execution.

C#

public enum DTSExecResult

Inheritance

Enum

DTSExecResult

Fields

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

Examples

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.

C#

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

Sample Output:

Task ran successfully

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.

Applies to