DataConnectionManager.GetDataConnection Method

Definition

Namespace:

Microsoft.VisualStudio.Data

Assembly:

Microsoft.VisualStudio.Data.dll

Package:

Microsoft.VisualStudio.Data v17.10.40170

Overloads

GetDataConnection(Guid, String, Boolean)	Retrieves a data connection that is equivalent to the specified connection information.
GetDataConnection(Guid, String, Boolean, Boolean)	Retrieves a data connection that is equivalent to the specified connection information, with an indication whether the connection information is updated.

GetDataConnection(Guid, String, Boolean)

Retrieves a data connection that is equivalent to the specified connection information.

public:
 Microsoft::VisualStudio::Data::DataConnection ^ GetDataConnection(Guid provider, System::String ^ connectionString, bool encryptedString);

public Microsoft.VisualStudio.Data.DataConnection GetDataConnection (Guid provider, string connectionString, bool encryptedString);

member this.GetDataConnection : Guid * string * bool -> Microsoft.VisualStudio.Data.DataConnection

Public Function GetDataConnection (provider As Guid, connectionString As String, encryptedString As Boolean) As DataConnection

Parameters

provider

Guid

DDEX provider GUID.

connectionString

String

DDEX provider connection string.

encryptedString

Boolean

Indication whether the connection string information is encrypted (true if encrypted.)

Returns

DataConnection

Returns a DataConnection object instance representing the requested connection.

Exceptions

ArgumentNullException

The connectionString parameter is null.

ArgumentException

The specified provider is not a registered DDEX provider.

GetDataConnection(Guid, String, Boolean, Boolean)

Retrieves a data connection that is equivalent to the specified connection information, with an indication whether the connection information is updated.

public:
 Microsoft::VisualStudio::Data::DataConnection ^ GetDataConnection(Guid provider, System::String ^ connectionString, bool encryptedString, bool update);

public Microsoft.VisualStudio.Data.DataConnection GetDataConnection (Guid provider, string connectionString, bool encryptedString, bool update);

member this.GetDataConnection : Guid * string * bool * bool -> Microsoft.VisualStudio.Data.DataConnection

Public Function GetDataConnection (provider As Guid, connectionString As String, encryptedString As Boolean, update As Boolean) As DataConnection

Parameters

provider

Guid

A DDEX data provider GUID.

connectionString

String

A connection string recognized by the data provider.

encryptedString

Boolean

Indicates whether the connection string parameter is encrypted (true if encrypted).

update

Boolean

Indicates whether the connection information is updated

Returns

DataConnection

Returns a DataConnection object instance representing the requested connection.