Package.CheckpointUsage Property

Reference

Definition

Namespace:: Microsoft.SqlServer.Dts.Runtime

Assembly:: Microsoft.SqlServer.ManagedDTS.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets or sets a value that specifies if or when a package is restarted.

public:
 property Microsoft::SqlServer::Dts::Runtime::DTSCheckpointUsage CheckpointUsage { Microsoft::SqlServer::Dts::Runtime::DTSCheckpointUsage get(); void set(Microsoft::SqlServer::Dts::Runtime::DTSCheckpointUsage value); };

[Microsoft.SqlServer.Dts.Runtime.Localization.LocalizablePropertyCategory(typeof(Microsoft.SqlServer.Dts.Runtime.Localized), "PropertyCategoryCheckpoints")]
[Microsoft.SqlServer.Dts.Runtime.Localization.LocalizablePropertyDescription(typeof(Microsoft.SqlServer.Dts.Runtime.Localized), "CheckpointUsageDesc")]
public Microsoft.SqlServer.Dts.Runtime.DTSCheckpointUsage CheckpointUsage { get; set; }

[<Microsoft.SqlServer.Dts.Runtime.Localization.LocalizablePropertyCategory(typeof(Microsoft.SqlServer.Dts.Runtime.Localized), "PropertyCategoryCheckpoints")>]
[<Microsoft.SqlServer.Dts.Runtime.Localization.LocalizablePropertyDescription(typeof(Microsoft.SqlServer.Dts.Runtime.Localized), "CheckpointUsageDesc")>]
member this.CheckpointUsage : Microsoft.SqlServer.Dts.Runtime.DTSCheckpointUsage with get, set

Public Property CheckpointUsage As DTSCheckpointUsage

Property Value

DTSCheckpointUsage

A value from the DTSCheckpointUsage enumeration.

Attributes: LocalizablePropertyCategoryAttribute LocalizablePropertyDescriptionAttribute

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

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.

Applies to

Share via