Connections.Contains Method (Object)

 

Indicates whether the ConnectionManager items in the collection can be accessed by using indexing without throwing an exception.

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

Public Function Contains (
	index As Object
) As Boolean

Parameters

index
Type: System.Object

The name, description, ID, or index to locate in the collection.

Return Value

Type: System.Boolean

true if the collection can be accessed by using the syntax Connections[index]. If true, the collection can be accessed by name, description, or index. false if indexing cannot be used to retrieve items from the Connections collection.

The following code sample removes a newly-added ADO.NET connection manager from the collection. It then uses the Contains method to make sure that the connection manager is removed.

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\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 myConns As Connections =  pkg.Connections 

            ' Show how many connections are in the package.
            Dim myConnsCount As Integer =  myConns.Count 
            Console.WriteLine("The number of connections is: {0}", myConnsCount)

            ' Add an OLEDB connection manager.
            Dim myConn As ConnectionManager =  pkg.Connections.Add("OLEDB") 
            myConn.Name = "My OLEDB ConnectionManager"
            myConn.ConnectionString = "Data Source=.;Initial Catalog=AdventureWorks;Provider=SQLOLEDB.1;Integrated Security=SSPI;Persist Security Info=False;Auto Translate=False;"

            ' Verify the addition of one connection manager.
            myConnsCount = myConns.Count
            Console.WriteLine("The number of connections now is: {0}", myConnsCount)

            ' Write out the names of the connection managers.
            Dim myCMgrs As ConnectionManager
            For Each myCMgrs In myConns
                Console.WriteLine("Name:        {0}", myCMgrs.Name)
                Console.WriteLine("ID:          {0}", myCMgrs.ID)
                Console.WriteLine("--------------------------------------------")
            Next

            ' Remove the connection manager by name.
            pkg.Connections.Remove("My OLEDB ConnectionManager")

            ' Verify the removal of the connection manager.
            myConnsCount = myConns.Count
            Console.WriteLine("The number of connections is finally: {0}", myConnsCount)

            ' Using the Contains method, verify if the connection is in the collection.
            Dim connRemoved As Boolean =  myConns.Contains("My OLEDB ConnectionManager") 
            Console.WriteLine("The connection is still in the collection? {0}", connRemoved)
            Console.WriteLine()
        End Sub
    End Class
End Namespace

Sample Output:

The number of connections is: 3

The number of connections now is: 4

Name: Create_Execute_Process_Dest.sql

ID: {B52C0D78-5402-4544-BFEC-2BE203900C91}

--------------------------------------------

Name: customers

ID: {4F945623-B43F-470F-9D1E-D2A0B09177AE}

--------------------------------------------

Name: localhost.AdventureWorks

ID: {47179DDF-BD08-4E29-87C4-3A3D77105C2B}

--------------------------------------------

Name: My OLEDB ConnectionManager

ID: {90DF568E-ECB1-46D2-8DCB-3E2C67391E64}

--------------------------------------------

The number of connections is finally: 3

The connection is still in the collection? False

Return to top
Show: