Package.CheckpointFileName Property

Gets or sets the name of the file that captures the checkpoint information, which enables a package to restart.

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

[EditorAttribute("Microsoft.DataTransformationServices.Controls.NonValidatingFileNameEditor, Microsoft.DataTransformationServices.Controls, Version=, Culture=neutral, PublicKeyToken=89845dcd8080cc91", typeof(UITypeEditor))] 
public string CheckpointFileName { get; set; }
/** @property */
public String get_CheckpointFileName ()

/** @property */
public void set_CheckpointFileName (String value)

public function get CheckpointFileName () : String

public function set CheckpointFileName (value : String)

Property Value

A String that contains the name of the checkpoint file.

When the package completes successfully, this file is deleted. For more information about using checkpoints, see Using Checkpoints in Packages.

The following example loads a package, and then retrieves several package properties, including the CheckpointFileName.

Class PackageTest
        static void Main(string[] args)
            // The variable pkg points to the location of the
            // ExecuteProcess package sample
            // installed with the samples.
            string pkg = @"C:\Program Files\Microsoft SQL Server\90\Samples\Integration Services\Package Samples\ExecuteProcess Sample\ExecuteProcess\UsingExecuteProcess.dtsx";
            Application app = new Application();
            Package p = app.LoadPackage(pkg, null);
            // Once the package is loaded, this sample can
           // query on several properties
            long cc = p.CertificateContext;
            string cfn = p.CheckpointFileName;
            DTSProtectionLevel pl = p.ProtectionLevel;
            DTSPackageType dpt = p.PackageType;

            Console.WriteLine("CertificateContext = " + cc);
            Console.WriteLine("CheckpointFileName = " + cfn);
            Console.WriteLine("ProtectionLevel = " + pl);
            Console.WriteLine("PackageType = " + dpt);

Sample Output:

CertificateContext = 0

CheckpointFileName =

ProtectionLevel = EncryptSensitiveWithUserKey

PackageType = Default

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