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
'Usage
Dim instance As IDtsConnectionService

public interface IDtsConnectionService

public interface class IDtsConnectionService

type IDtsConnectionService =  interface end

public interface IDtsConnectionService

The IDtsConnectionService type exposes the following members.

Properties

	Name	Description
	IsDesignerOnline	Gets or sets a Boolean indicating whether the designer is working in an offline mode or online mode.

Top

Methods

	Name	Description
	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 connection type specified as a parameter.
	CreateConnection(String, ConnectionManagerUIArgs)	Creates a new connection using the connection type specified as a parameter.
	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.
	GetConnectionsOfType	Returns all connections of the specified type found in the current package.
	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;

See Also

Reference

Microsoft.SqlServer.Dts.Runtime.Design Namespace