DTSCheckpointUsage Enum

Definition

Specifies values that describe if, or when, a package is restarted.

C#
public enum DTSCheckpointUsage
Inheritance
DTSCheckpointUsage

Fields

Name Value Description
Never 0

Specifies that the package never restarts. This is the default value.

IfExists 1

Specifies that the package restarts if the file specified by the CheckpointFileName is found.

Always 2

Specifies that the package always restarts.

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 IfExists to force package to restart 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

Applies to

Product Versions
SQL Server .NET SDK 2016, 2017, 2019