DTSCheckpointUsage Enumeration

Article
12/03/2008

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

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

Syntax

'Declaration
Public Enumeration DTSCheckpointUsage

public enum DTSCheckpointUsage

public enum class DTSCheckpointUsage

public enum DTSCheckpointUsage

public enum DTSCheckpointUsage

Members

Member name	Description
Always	Specifies that the package always restarts.
IfExists	Specifies that the package restarts if the file specified by the CheckpointFileName is found.
Never	Specifies that the package never restarts. This is the default value.

Example

The following code example sets the CheckpointUsage property.

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\90\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);
        }
    }
}

Imports System
Imports System.Collections.Generic
Imports System.Text
Imports Microsoft.SqlServer.Dts.Runtime
 
Namespace Package_API
    Class Program
        Shared  Sub Main(ByVal args() As String)
                    Dim app As Application =  New Application() 
            Dim pkg As Package =  New Package() 
            pkg = app.LoadPackage("C:\Program Files\Microsoft SQL Server\90\Samples\Integration Services\Package Samples\CalculatedColumns Sample\CalculatedColumns\CalculatedColumns.dtsx", Nothing)
 
            ' 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)
        End Sub
    End Class
End Namespace

Sample Output:

Check for existing checkpoint file? IfExists

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms