IDtsConnectionService Interface
Provides a service that can be used by various user interfaces to create new connections.
Namespace: Microsoft.SqlServer.Dts.Runtime.Design
Assembly: Microsoft.SqlServer.Dts.Design (in Microsoft.SqlServer.Dts.Design.dll)
Syntax
'Declaration
Public Interface IDtsConnectionService _
Inherits IDtsConnectionBaseService
'Usage
Dim instance As IDtsConnectionService
public interface IDtsConnectionService : IDtsConnectionBaseService
public interface class IDtsConnectionService : IDtsConnectionBaseService
type IDtsConnectionService =
interface
interface IDtsConnectionBaseService
end
public interface IDtsConnectionService extends IDtsConnectionBaseService
The IDtsConnectionService type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
IsDesignerOnline | Gets a value that indicates whether the designer is working in an online mode. (Inherited from IDtsConnectionBaseService.) |
Top
Methods
| Name | Description | |
|---|---|---|
.gif "Public method") |
AddConnectionToPackage | Adds existing connections to a package designer so that the designer is aware of a new connection manager |
|
CreateConnection(String) | Creates a new connection using the specified connection type. (Inherited from IDtsConnectionBaseService.) |
|
CreateConnection(String, ConnectionManagerUIArgs) | Creates a new connection using the specified connection type and argument. (Inherited from IDtsConnectionBaseService.) |
|
CreateConnectionFromDataSource | Displays a list of existing data sources and allows users to create connection managers based on data sources. |
|
EditConnection(ConnectionManager) | Edits a specific existing connection and returns a value that indicates whether the connection was modified. |
|
EditConnection(ConnectionManager, ConnectionManagerUIArgs) | Edits a specific existing connection and returns a value to indicate whether the connection was modified. |
|
GetAMOObject | Retrieves the AMO object for an OLAP connection. |
|
GetConnections | Retrieves all connection managers in the current package. (Inherited from IDtsConnectionBaseService.) |
|
GetConnectionsOfType | Returns all connections of the specified type found in the current package. (Inherited from IDtsConnectionBaseService.) |
|
GetDataSource | Retrieves the DataSource object for a connection. |
|
SetDataSourceID | Allows the connection string for a run-time connection manager to be in synchronization with the connection string of a Data Source object, if both are in the same project. This synchronization is done whenever a package is opened in the designer. |
|
SetReferencedProject | Sets the referenced project to a connection manager. |
Top
Remarks
This service can be used by any kind of user interface, whether that be a task, connection manager, transform, log provider, or others.
Examples
The following code example shows the use of the IDtsConnectionService.
IDtsConnectionService dtsConnectionService = serviceProvider.GetService(typeof(IDtsConnectionService)) as IDtsConnectionService;