Package.CheckpointUsage Property


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

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

Public Property CheckpointUsage As DTSCheckpointUsage

Property Value

Type: Microsoft.SqlServer.Dts.Runtime.DTSCheckpointUsage

A value from the DTSCheckpointUsage enumeration.

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.

The following code example sets the CheckpointUsage property.

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\100\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

Return to top