Share via

DataExplorerConnectionManager.FindConnection Method

  • Reference

Definition

Namespace:
Microsoft.VisualStudio.Data
Assembly:
Microsoft.VisualStudio.Data.dll
Package:
Microsoft.VisualStudio.Data v17.5.33428.388

Overloads

FindConnection(String)

Locates a DataExplorerConnection object instance with a specified display name.
FindConnection(Guid, String, Boolean)

Locates a DataExplorerConnection object instance with specified connection settings.

FindConnection(String)

Locates a DataExplorerConnection object instance with a specified display name.

public:
 abstract Microsoft::VisualStudio::Data::DataExplorerConnection ^ FindConnection(System::String ^ connectionName);
public abstract Microsoft.VisualStudio.Data.DataExplorerConnection FindConnection (string connectionName);
abstract member FindConnection : string -> Microsoft.VisualStudio.Data.DataExplorerConnection
Public MustOverride Function FindConnection (connectionName As String) As DataExplorerConnection

Parameters

connectionName
String

The display name of an existing connection.

Returns

DataExplorerConnection

Returns a DataExplorerConnection object instance representing the specified connection, or returns null if no such connection could be found.

Exceptions

ArgumentNullException

The connectionName parameter is null.

Applies to

FindConnection(Guid, String, Boolean)

Locates a DataExplorerConnection object instance with specified connection settings.

public:
 abstract Microsoft::VisualStudio::Data::DataExplorerConnection ^ FindConnection(Guid provider, System::String ^ connectionString, bool encryptedString);
public abstract Microsoft.VisualStudio.Data.DataExplorerConnection FindConnection (Guid provider, string connectionString, bool encryptedString);
abstract member FindConnection : Guid * string * bool -> Microsoft.VisualStudio.Data.DataExplorerConnection
Public MustOverride Function FindConnection (provider As Guid, connectionString As String, encryptedString As Boolean) As DataExplorerConnection

Parameters

provider
Guid

The global unique identifier (guid) of a DDEX provider.

connectionString
String

An unencrypted or encrypted string containing connection information.

encryptedString
Boolean

A Boolean flag indicating whether the connectionString parameter is unencrypted or encrypted.

Returns

DataExplorerConnection

Returns a DataExplorerConnection object instance representing the specified connection, or returns null if no such connection is found.

Exceptions

ArgumentNullException

The connectionString parameter is null.

ArgumentException

The provider is not a registered DDEX provider.

Applies to