IVsDataConnectionManager.GetConnection Method

Definition

Namespace:

Microsoft.VisualStudio.Data.Services

Assembly:

Microsoft.VisualStudio.Data.Services.dll

Package:

Microsoft.VisualStudio.Data.Services v17.10.40170

Overloads

GetConnection(Guid, String, Boolean)	Retrieves an existing data connection or creates a new data connection that matches the specified provider GUID and connection string.
GetConnection(Guid, String, Boolean, Boolean)	Retrieves an existing data connection or creates a new data connection that matches the specified provider GUID and connection string. Also, optionally updates the connection string of the returned connection.

GetConnection(Guid, String, Boolean)

Retrieves an existing data connection or creates a new data connection that matches the specified provider GUID and connection string.

public:
 Microsoft::VisualStudio::Data::Services::IVsDataConnection ^ GetConnection(Guid provider, System::String ^ connectionString, bool encryptedString);

public Microsoft.VisualStudio.Data.Services.IVsDataConnection GetConnection (Guid provider, string connectionString, bool encryptedString);

abstract member GetConnection : Guid * string * bool -> Microsoft.VisualStudio.Data.Services.IVsDataConnection

Public Function GetConnection (provider As Guid, connectionString As String, encryptedString As Boolean) As IVsDataConnection

Parameters

provider

Guid

The GUID of the DDEX provider.

connectionString

String

The connection string in unencrypted or encrypted form.

encryptedString

Boolean

A Boolean value indicating whether the connection string is encrypted (true) or unencrypted (false).

Returns

IVsDataConnection

An IVsDataConnection object representing the data connection.

GetConnection(Guid, String, Boolean, Boolean)

Retrieves an existing data connection or creates a new data connection that matches the specified provider GUID and connection string. Also, optionally updates the connection string of the returned connection.

public:
 Microsoft::VisualStudio::Data::Services::IVsDataConnection ^ GetConnection(Guid provider, System::String ^ connectionString, bool encryptedString, bool update);

public Microsoft.VisualStudio.Data.Services.IVsDataConnection GetConnection (Guid provider, string connectionString, bool encryptedString, bool update);

abstract member GetConnection : Guid * string * bool * bool -> Microsoft.VisualStudio.Data.Services.IVsDataConnection

Public Function GetConnection (provider As Guid, connectionString As String, encryptedString As Boolean, update As Boolean) As IVsDataConnection

Parameters

provider

Guid

The GUID of the DDEX provider.

connectionString

String

The connection string in unencrypted or encrypted form.

encryptedString

Boolean

A Boolean value indicating whether the connection string is encrypted (true) or unencrypted (false).

update

Boolean

A Boolean value indicating whether the data connection's connection string value should be updated with the specified connection string (true) or not (false).

Returns

IVsDataConnection

An IVsDataConnection object representing the data connection.