IDtsConnectionService.CreateConnection Method (String)

Article
12/03/2008

Creates a new connection using the connection type specified as a parameter.

Namespace: Microsoft.SqlServer.Dts.Runtime.Design
Assembly: Microsoft.SqlServer.Dts.Design (in microsoft.sqlserver.dts.design.dll)

Syntax

'Declaration
Function CreateConnection ( _
    connectionType As String _
) As ArrayList

ArrayList CreateConnection (
    string connectionType
)

ArrayList^ CreateConnection (
    String^ connectionType
)

ArrayList CreateConnection (
    String connectionType
)

function CreateConnection (
    connectionType : String
) : ArrayList

Parameters

connectionType
The type of connection you want to put in the array.

Return Value

An ArrayList containing the collection of connections created. An empty collection is returned if an error occurs or if the user cancels the request.

Remarks

The implementation code can be written to provide a list of connections in the user interface for user convenience.

Example

The following code example shows how to get the list of connection types when the service is a file connection.

// Service is a connection service.
IDtsConnectionService dtsConnectionService = 
    serviceProvider.GetService(typeof(IDtsConnectionService)) as 
    IDtsConnectionService;
ArrayList list = dtsConnectionService.CreateConnection(connectionType);
ConnectionManager cMgr = (ConnectionManager)list[0];

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