DTSCheckpointUsage Enumeration
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
'Usage
Dim instance As DTSCheckpointUsage
public enum DTSCheckpointUsage
public enum class DTSCheckpointUsage
type 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. |
Examples
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\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);
}
}
}
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 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)
End Sub
End Class
End Namespace
Sample Output:
Check for existing checkpoint file? IfExists