Package.Connections Property

Definition

Namespace:

Microsoft.SqlServer.Dts.Runtime

Assembly:

Microsoft.SqlServer.ManagedDTS.dll

Gets the collection of connection managers for the package.

public:
 property Microsoft::SqlServer::Dts::Runtime::Connections ^ Connections { Microsoft::SqlServer::Dts::Runtime::Connections ^ get(); };

public Microsoft.SqlServer.Dts.Runtime.Connections Connections { get; }

member this.Connections : Microsoft.SqlServer.Dts.Runtime.Connections

Public ReadOnly Property Connections As Connections

Property Value

Connections

The collection of connection managers for the package.

Examples

The following example loads the UsingExecuteProcess package sample, and then retrieves the connections that are used by the package and displays some properties about the connections.

static void Main(string[] args)  
        {  
            // The variable pkg points to the location  
            // of the ExecuteProcess package sample   
            // that is installed with the samples.  
            string pkg = @"C:\Program Files\Microsoft SQL Server\100\Samples\Integration Services\Package Samples\ExecuteProcess Sample\ExecuteProcess\UsingExecuteProcess.dtsx";  

            Application app = new Application();  
            Package p = app.LoadPackage(pkg, null);  
            Connections conns = p.Connections;  
            foreach (ConnectionManager cm in conns)  
                Console.WriteLine("Name = " + cm.CreationName + ", HostType = " + cm.HostType);  
        }  

Shared  Sub Main(ByVal args() As String)  
            ' The variable pkg points to the location  
            ' of the ExecuteProcess package sample   
            ' that is installed with the samples.  
            Dim pkg As String =  "C:\Program Files\Microsoft SQL Server\100\Samples\Integration Services\Package Samples\ExecuteProcess Sample\ExecuteProcess\UsingExecuteProcess.dtsx"   

            Dim app As Application =  New Application()   
            Dim p As Package =  app.LoadPackage(pkg,Nothing)   
            Dim conns As Connections =  p.Connections   
            Dim cm As ConnectionManager  
            For Each cm In conns  
                Console.WriteLine("Name = " + cm.CreationName + ", HostType = " + cm.HostType)  
            Next  
End Sub  

Sample Output:

Name = FILE, HostType = ConnectionManager

Name = OLEDB, HostType = ConnectionManager

Name = OLEDB, HostType = ConnectionManager

Remarks

Connection managers provide tasks with a generic interface to the underlying data store, allowing for simpler task implementation. Use the AcquireConnection method of the ConnectionManager object to retrieve the necessary connection information from any of the connection manager objects in the collection.

The connection manager can be referenced by GUID or by name, and you can store the name of the connection manager in a configuration file. To reference the connection by name, use \Package.Connections[myConnection].ConnectionString, instead of using \Package.Connections[{9930DA64-A413-4286-9C66-74EDADB4F393}].ConnectionString.

For more information about connections and connection managers, see Integration Services (SSIS) Connections.