ConnectionManager.Name Property

Article
12/03/2008

Gets or sets the name of the ConnectionManager object.

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

Syntax

'Declaration
Public Property Name As String

public string Name { get; set; }

public:
virtual property String^ Name {
    String^ get () sealed;
    void set (String^ value) sealed;
}

/** @property */
public final String get_Name ()

/** @property */
public final void set_Name (String value)

public final function get Name () : String

public final function set Name (value : String)

Property Value

A String that contains the name that you gave to the connection manager object when it was created.

Remarks

This is the name given to the connection manager when it is created that can be modified later. In the graphical user interface, the name appears in the Connection Manager editor or property list as the Name property. If a name is not assigned when the connection is created, the runtime assigns the GUID that was generated for the ID.

Example

The following code example loads an existing package that has two connections. It iterates through the connection managers in the package and prints out the values for the various properties, including the Name.

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

namespace Connections_Collection
{
    class Program
    {
        static void Main(string[] args)
        {
           // The package is one of the SSIS Samples.
            string mySample = @"C:\Program Files\Microsoft SQL Server\90\Samples\Integration Services\Package Samples\CalculatedColumns Sample\CalculatedColumns\CalculatedColumns.dtsx";
            
            // Create an application and load the sample.
            Application app = new Application();
            Package pkg = app.LoadPackage(mySample, null);
            Connections myConns = pkg.Connections;
            int connCount = myConns.Count;
            Console.WriteLine("The number of connections in the package is: {0}", connCount);
            
            // Enumerate over the collection, printing out
            // the values for various properties.
            foreach (ConnectionManager connMgr in myConns)
            {
                Console.WriteLine("ConnectionString:        {0}", connMgr.ConnectionString);
                Console.WriteLine("CreationName:            {0}", connMgr.CreationName);
                Console.WriteLine("DelayValidation:         {0}", connMgr.DelayValidation);
                Console.WriteLine("Description:             {0}", connMgr.Description);
                Console.WriteLine("HostType:                {0}", connMgr.HostType);
                Console.WriteLine("ID:                      {0}", connMgr.ID);
                Console.WriteLine("InnerObject:             {0}", connMgr.InnerObject);
                Console.WriteLine("Name:                    {0}", connMgr.Name);
                Console.WriteLine("ProtectionLevel:         {0}", connMgr.ProtectionLevel);
                Console.WriteLine("SupportsDTCTransactions: {0}", connMgr.SupportsDTCTransactions);
            }
            Console.WriteLine("");
        }
    }
}

Imports System
Imports System.Collections.Generic
Imports System.Text
Imports Microsoft.SqlServer.Dts.Runtime
 
Namespace Connections_Collection
    Class Program
        Shared  Sub Main(ByVal args() As String)
           ' The package is one of the SSIS Samples.
            Dim mySample As String =  "C:\Program Files\Microsoft SQL Server\90\Samples\Integration Services\Package Samples\CalculatedColumns Sample\CalculatedColumns\CalculatedColumns.dtsx" 
 
            ' Create an application and load the sample.
            Dim app As Application =  New Application() 
            Dim pkg As Package =  app.LoadPackage(mySample,Nothing) 
            Dim myConns As Connections =  pkg.Connections 
            Dim connCount As Integer =  myConns.Count 
            Console.WriteLine("The number of connections in the package is: {0}", connCount)
 
            ' Enumerate over the collection, printing out
            ' the values for various properties.
            Dim connMgr As ConnectionManager
            For Each connMgr In myConns
                Console.WriteLine("ConnectionString:        {0}", connMgr.ConnectionString)
                Console.WriteLine("CreationName:            {0}", connMgr.CreationName)
                Console.WriteLine("DelayValidation:         {0}", connMgr.DelayValidation)
                Console.WriteLine("Description:             {0}", connMgr.Description)
                Console.WriteLine("HostType:                {0}", connMgr.HostType)
                Console.WriteLine("ID:                      {0}", connMgr.ID)
                Console.WriteLine("InnerObject:             {0}", connMgr.InnerObject)
                Console.WriteLine("Name:                    {0}", connMgr.Name)
                Console.WriteLine("ProtectionLevel:         {0}", connMgr.ProtectionLevel)
                Console.WriteLine("SupportsDTCTransactions: {0}", connMgr.SupportsDTCTransactions)
            Next
 
            Console.WriteLine("")
        End Sub
    End Class
End Namespace

Sample Output:

The number of connections in the package is: 2

ConnectionString: Data Source=localhost;Initial Catalog=AdventureWorks;Provider=SQLOLEDB.1;Integrated Security=SSPI;Persist Security Info=False;Auto Translate=False;

CreationName: OLEDB

DelayValidation: False

Description:

HostType: ConnectionManager

ID: {3427BFE1-F10C-4B7E-8E70-E8D9DC7DDBA3}

InnerObject: System.__ComObject

Name: localhost.AdventureWorks

ProtectionLevel: EncryptSensitiveWithUserKey

SupportsDTCTransactions: True

ConnectionString: C:\Program Files\Microsoft SQL Server\90\Samples\Integration Services\Package Samples\CalculatedColumns Sample\CalculatedColumns\results.txt

CreationName: FLATFILE

DelayValidation: False

Description:

HostType: ConnectionManager

ID: {48B66F8D-7DFE-4D85-91C7-0999655484B2}

InnerObject: System.__ComObject

Name: Transaction Summary by Product1

ProtectionLevel: EncryptSensitiveWithUserKey

SupportsDTCTransactions: False

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