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)
Syntax
'Declaration
Public Property CheckpointUsage As DTSCheckpointUsage
Get
Set
'Usage
Dim instance As Package
Dim value As DTSCheckpointUsage
value = instance.CheckpointUsage
instance.CheckpointUsage = value
public DTSCheckpointUsage CheckpointUsage { get; set; }
public:
property DTSCheckpointUsage CheckpointUsage {
DTSCheckpointUsage get ();
void set (DTSCheckpointUsage value);
}
member CheckpointUsage : DTSCheckpointUsage with get, set
function get CheckpointUsage () : DTSCheckpointUsage
function set CheckpointUsage (value : DTSCheckpointUsage)
Property Value
Type: Microsoft.SqlServer.Dts.Runtime.DTSCheckpointUsage
A value from the DTSCheckpointUsage enumeration.
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.
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 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\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