Export (0) Print
Expand All

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 DTSCheckpointUsage CheckpointUsage { get; set; }
/** @property */
public DTSCheckpointUsage get_CheckpointUsage ()

/** @property */
public void set_CheckpointUsage (DTSCheckpointUsage value)

public function get CheckpointUsage () : DTSCheckpointUsage

public function set CheckpointUsage (value : DTSCheckpointUsage)

Property Value

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 Using Checkpoints in Packages.


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

Sample Output:

Check for existing checkpoint file? IfExists

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Development Platforms

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

Target Platforms

Community Additions

ADD
Show:
© 2014 Microsoft