Package.CheckpointUsage Property

Article
12/03/2008

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

public DTSCheckpointUsage CheckpointUsage { get; set; }

public:
property DTSCheckpointUsage CheckpointUsage {
    DTSCheckpointUsage get ();
    void set (DTSCheckpointUsage value);
}

/** @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.

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

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

Thread Safety

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.

Platforms

Development Platforms

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

Target Platforms