DtsContainer.LocaleID Property

Article
07/16/2015

Applies To: SQL Server 2016 Preview

Gets or sets an Integer that indicates the Microsoft Win32® localeID to use when the DtsContainer object is executed.

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

Syntax

public int LocaleID { get; set; }

public:
property int LocaleID {
    int get();
    void set(int value);
}

member LocaleID : int with get, set

Public Property LocaleID As Integer

Property Value

Type: System.Int32

An Integer that represents the locale. A value of –1 indicates that the parent locale should be used. Otherwise, the LocaleID set on this container is used.

Remarks

The LocaleID is inherited from the parent container by default. If you are inheriting from the package container and change the package LocaleID, the new value is retained on the parent container and propagated to all child containers.

Examples

Legacy Code Example

The following code example creates a Package, which is a class that inherits from DtsContainer. The Package shows the use of several inherited properties.

using System;
using System.Collections.Generic;
using System.Text;
using Microsoft.SqlServer.Dts.Runtime;

namespace Microsoft.SqlServer.SSIS.Samples
{
    class Program
    {
        static void Main(string[] args)
        {
            Application app = new Application();
            Package pkg = new Package();

            // Package name must be assigned.
            pkg.Name = "My DtsContainer inheritance test package";

            // Display the values that manually assigned.
            Console.WriteLine("Package Name: {0}", pkg.Name);

            // Packages are assigned the following default values when created.
            Console.WriteLine("Package ID:           {0}", pkg.ID);
            Console.WriteLine("FailPackageOnFailure: {0}", pkg.FailPackageOnFailure);
            Console.WriteLine("FailParentOnFailure:  {0}", pkg.FailParentOnFailure);
            Console.WriteLine("Locale ID:            {0}", pkg.LocaleID);
            Console.WriteLine("Is DefaultLocaleID?   {0}", pkg.IsDefaultLocaleID);
            Console.WriteLine("Isolation Level:      {0}", pkg.IsolationLevel);
            Console.WriteLine("LoggingMode:          {0}", pkg.LoggingMode);
            Console.WriteLine("MaximumErrorCount:    {0}", pkg.MaximumErrorCount);
            Console.WriteLine("TransactionOption:    {0}", pkg.TransactionOption);
        }
    }
}

Imports System
Imports System.Collections.Generic
Imports System.Text
Imports Microsoft.SqlServer.Dts.Runtime
 
Namespace Microsoft.SqlServer.SSIS.Samples
    Class Program
        Shared  Sub Main(ByVal args() As String)
            Dim app As Application =  New Application() 
            Dim pkg As Package =  New Package() 
 
            ' Package name must be assigned.
            pkg.Name = "My DtsContainer inheritance test package"
 
            ' Display the values that manually assigned.
            Console.WriteLine("Package Name: {0}", pkg.Name)
 
            ' Packages are assigned the following default values when created.
            Console.WriteLine("Package ID:           {0}", pkg.ID)
            Console.WriteLine("FailPackageOnFailure: {0}", pkg.FailPackageOnFailure)
            Console.WriteLine("FailParentOnFailure:  {0}", pkg.FailParentOnFailure)
            Console.WriteLine("Locale ID:            {0}", pkg.LocaleID)
            Console.WriteLine("Is DefaultLocaleID?   {0}", pkg.IsDefaultLocaleID)
            Console.WriteLine("Isolation Level:      {0}", pkg.IsolationLevel)
            Console.WriteLine("LoggingMode:          {0}", pkg.LoggingMode)
            Console.WriteLine("MaximumErrorCount:    {0}", pkg.MaximumErrorCount)
            Console.WriteLine("TransactionOption:    {0}", pkg.TransactionOption)
        End Sub
    End Class
End Namespace

Sample Output:

Package Name: My DtsContainer inheritance test package

Package ID: {2C2FAA96-35BA-4C5E-A39A-C5D7D30A0D79}

FailPackageOnFailure: False

FailParentOnFailure: False

Locale ID: 1033

Is DefaultLocaleID? False

Isolation Level: Serializable

LoggingMode: UseParentSetting

MaximumErrorCount: 1

TransactionOption: Supported