DtsContainer.FailPackageOnFailure Property

Definition

Namespace:

Microsoft.SqlServer.Dts.Runtime

Assembly:

Microsoft.SqlServer.ManagedDTS.dll

Gets or sets a Boolean that indicates whether the package fails when a child container fails. This property is used on containers, not the package itself.

public:
 property bool FailPackageOnFailure { bool get(); void set(bool value); };

[Microsoft.SqlServer.Dts.Runtime.Localization.LocalizablePropertyCategory(typeof(Microsoft.SqlServer.Dts.Runtime.Localized), "PropertyCategoryExecution")]
[Microsoft.SqlServer.Dts.Runtime.Localization.LocalizablePropertyDescription(typeof(Microsoft.SqlServer.Dts.Runtime.Localized), "FailPackageOnFailureDesc")]
public bool FailPackageOnFailure { get; set; }

[<Microsoft.SqlServer.Dts.Runtime.Localization.LocalizablePropertyCategory(typeof(Microsoft.SqlServer.Dts.Runtime.Localized), "PropertyCategoryExecution")>]
[<Microsoft.SqlServer.Dts.Runtime.Localization.LocalizablePropertyDescription(typeof(Microsoft.SqlServer.Dts.Runtime.Localized), "FailPackageOnFailureDesc")>]
member this.FailPackageOnFailure : bool with get, set

Public Property FailPackageOnFailure As Boolean

Property Value

Boolean

true indicates that a failure in the container will set the package execution results to failure.

Attributes

LocalizablePropertyCategoryAttribute LocalizablePropertyDescriptionAttribute

Examples

The following code example creates a Package, which is a class that inherits from DtsContainer. The Package shows the use of several inherited properties.

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

namespace Microsoft.SqlServer.SSIS.Samples  
{  
    class Program  
    {  
        static void Main(string[] args)  
        {  
            Application app = new Application();  
            Package pkg = new Package();  

            // Package name must be assigned.  
            pkg.Name = "My DtsContainer inheritance test package";  

            // Display the values that manually assigned.  
            Console.WriteLine("Package Name: {0}", pkg.Name);  

            // Packages are assigned the following default values when created.  
            Console.WriteLine("Package ID:           {0}", pkg.ID);  
            Console.WriteLine("FailPackageOnFailure: {0}", pkg.FailPackageOnFailure);  
            Console.WriteLine("FailParentOnFailure:  {0}", pkg.FailParentOnFailure);  
            Console.WriteLine("Locale ID:            {0}", pkg.LocaleID);  
            Console.WriteLine("Is DefaultLocaleID?   {0}", pkg.IsDefaultLocaleID);  
            Console.WriteLine("Isolation Level:      {0}", pkg.IsolationLevel);  
            Console.WriteLine("LoggingMode:          {0}", pkg.LoggingMode);  
            Console.WriteLine("MaximumErrorCount:    {0}", pkg.MaximumErrorCount);  
            Console.WriteLine("TransactionOption:    {0}", pkg.TransactionOption);  
        }  
    }  
}  

Imports System  
Imports System.Collections.Generic  
Imports System.Text  
Imports Microsoft.SqlServer.Dts.Runtime  

Namespace Microsoft.SqlServer.SSIS.Samples  
    Class Program  
        Shared  Sub Main(ByVal args() As String)  
            Dim app As Application =  New Application()   
            Dim pkg As Package =  New Package()   

            ' Package name must be assigned.  
            pkg.Name = "My DtsContainer inheritance test package"  

            ' Display the values that manually assigned.  
            Console.WriteLine("Package Name: {0}", pkg.Name)  

            ' Packages are assigned the following default values when created.  
            Console.WriteLine("Package ID:           {0}", pkg.ID)  
            Console.WriteLine("FailPackageOnFailure: {0}", pkg.FailPackageOnFailure)  
            Console.WriteLine("FailParentOnFailure:  {0}", pkg.FailParentOnFailure)  
            Console.WriteLine("Locale ID:            {0}", pkg.LocaleID)  
            Console.WriteLine("Is DefaultLocaleID?   {0}", pkg.IsDefaultLocaleID)  
            Console.WriteLine("Isolation Level:      {0}", pkg.IsolationLevel)  
            Console.WriteLine("LoggingMode:          {0}", pkg.LoggingMode)  
            Console.WriteLine("MaximumErrorCount:    {0}", pkg.MaximumErrorCount)  
            Console.WriteLine("TransactionOption:    {0}", pkg.TransactionOption)  
        End Sub  
    End Class  
End Namespace  

Sample Output:

Package Name: My DtsContainer inheritance test package

Package ID: {2C2FAA96-35BA-4C5E-A39A-C5D7D30A0D79}

FailPackageOnFailure: False

FailParentOnFailure: False

Locale ID: 1033

Is DefaultLocaleID? False

Isolation Level: Serializable

LoggingMode: UseParentSetting

MaximumErrorCount: 1

TransactionOption: Supported

Remarks

If FailPackageOnFailure is true and the execution result of a container is a failure, the execution result assigned to the package that is the parent of the failed container is also failure. This results in the package terminating. This event defines a restartable package failure. Packages that do not complete because their execution was cancelled cannot be restarted. For more information, see Restart Packages by Using Checkpoints.

This property cannot be set on the Package. Setting this value to true on the package will result in an error.