Package.CheckpointUsage Property

Definition

Namespace:

Microsoft.SqlServer.Dts.Runtime

Assembly:

Microsoft.SqlServer.ManagedDTS.dll

Gets or sets a value that specifies if or when a package is restarted.

C#

[Microsoft.SqlServer.Dts.Runtime.Localization.LocalizablePropertyCategory(typeof(Microsoft.SqlServer.Dts.Runtime.Localized), "PropertyCategoryCheckpoints")]
[Microsoft.SqlServer.Dts.Runtime.Localization.LocalizablePropertyDescription(typeof(Microsoft.SqlServer.Dts.Runtime.Localized), "CheckpointUsageDesc")]
public Microsoft.SqlServer.Dts.Runtime.DTSCheckpointUsage CheckpointUsage { get; set; }

Property Value

DTSCheckpointUsage

A value from the DTSCheckpointUsage enumeration.

Attributes

LocalizablePropertyCategoryAttribute LocalizablePropertyDescriptionAttribute

Examples

The following code example sets the CheckpointUsage property.

C#

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

namespace Package_API  
{  
    class Program  
    {  
        static void Main(string[] args)  
        {  
                    Application app = new Application();  
            Package pkg = new Package();  
            pkg = app.LoadPackage(@"C:\Program Files\Microsoft SQL Server\100\Samples\Integration Services\Package Samples\CalculatedColumns Sample\CalculatedColumns\CalculatedColumns.dtsx", null);  

            // Set the CheckpointUsage to IfExistts to force package to retart if  
            // the file specified by the CheckpointFileName property is found.  
            pkg.CheckpointUsage = DTSCheckpointUsage.IfExists;  

            Console.WriteLine("Check for existing checkpoint file? {0}", pkg.CheckpointUsage);  
        }  
    }  
}  

Sample Output:

Check for existing checkpoint file? IfExists

Remarks

The default value of this property is Never, which indicates that the package cannot be restarted. For more information about the use of checkpoints in a package, see Restart Packages by Using Checkpoints.

Applies to