Connections.Item[Object] Property

Definition

Namespace:

Microsoft.SqlServer.Dts.Runtime

Assembly:

Microsoft.SqlServer.ManagedDTS.dll

Gets a ConnectionManager object from the Connections collection.

public:
 property Microsoft::SqlServer::Dts::Runtime::ConnectionManager ^ default[System::Object ^] { Microsoft::SqlServer::Dts::Runtime::ConnectionManager ^ get(System::Object ^ index); };

public Microsoft.SqlServer.Dts.Runtime.ConnectionManager this[object index] { get; }

member this.Item(obj) : Microsoft.SqlServer.Dts.Runtime.ConnectionManager

Default Public ReadOnly Property Item(index As Object) As ConnectionManager

Parameters

index

Object

The name, identity, ID, or index of the ConnectionManager object to return.

Property Value

ConnectionManager

A ConnectionManager object from the collection.

Examples

The following code sample retrieves an item from the collection using two methods. The first method uses the conns[0] syntax to retrieve the whole object located in the first position of the collection and put it in the myConnMgr variable. You can now retrieve all properties from the myConnMgr as usual. The second method retrieves a specific property from the first object in the collection using the conns[0].<property> syntax.

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

namespace Connections_Item  
{  
    class Program  
    {  
        static void Main(string[] args)  
        {  
            // The package is one of the SSIS Samples.  
            string mySample = @"C:\Program Files\Microsoft SQL Server\100\Samples\Integration Services\Package Samples\ExecuteProcess Sample\ExecuteProcess\UsingExecuteProcess.dtsx";  

            // Create an application and load the sample.  
            Application app = new Application();  
            Package pkg = app.LoadPackage(mySample, null);  
            Connections conns = pkg.Connections;  

            //Using the Item method syntax of [x], obtain the  
            // entire first entry, and then just the name.  
            ConnectionManager myConnMgr = conns[0];  
            String nameOfFirstItem = conns[0].Name;  

            //Print the name of the connection manager located at position [0].  
            Console.WriteLine("The ID of the first connection info is: {0}", myConnMgr.ID);  
            Console.WriteLine("The Name of the first connection info is: {0}", nameOfFirstItem);  
        }  
    }  
}  

Imports System  
Imports System.Collections.Generic  
Imports System.Text  
Imports Microsoft.SqlServer.Dts.Runtime  

Namespace Connections_Item  
    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\100\Samples\Integration Services\Package Samples\ExecuteProcess Sample\ExecuteProcess\UsingExecuteProcess.dtsx"   

            ' Create an application and load the sample.  
            Dim app As Application =  New Application()   
            Dim pkg As Package =  app.LoadPackage(mySample,Nothing)   
            Dim conns As Connections =  pkg.Connections   

            'Using the Item method syntax of [x], obtain the  
            ' entire first entry, and then just the name.  
            Dim myConnMgr As ConnectionManager =  conns(0)   
            Dim nameOfFirstItem As String =  conns(0).Name   

            'Print the name of the connection manager located at position [0].  
            Console.WriteLine("The ID of the first connection info is: {0}", myConnMgr.ID)  
            Console.WriteLine("The Name of the first connection info is: {0}", nameOfFirstItem)  
        End Sub  
    End Class  
End Namespace  

Sample Output:

The ID of the first connection info is: {B52C0D78-5402-4544-BFEC-2BE203900C91}

The Name of the first connection info is: Create_Execute_Process_Dest.sql

Remarks

If the call to the Contains method returns true, you can access the specified element in the collection using the syntax Connections[index]. If the Contains method returns false, this property throws an exception. In C#, this property is the indexer for the Connections class.