Share via


DataExplorerConnectionManager.FindConnection Method (Guid, String, Boolean)

Locates a DataExplorerConnection object instance with specified connection settings.

Namespace:  Microsoft.VisualStudio.Data
Assembly:  Microsoft.VisualStudio.Data (in Microsoft.VisualStudio.Data.dll)

Syntax

'Declaration
Public MustOverride Function FindConnection ( _
    provider As Guid, _
    connectionString As String, _
    encryptedString As Boolean _
) As DataExplorerConnection
public abstract DataExplorerConnection FindConnection(
    Guid provider,
    string connectionString,
    bool encryptedString
)
public:
virtual DataExplorerConnection^ FindConnection(
    Guid provider, 
    String^ connectionString, 
    bool encryptedString
) abstract
abstract FindConnection : 
        provider:Guid * 
        connectionString:string * 
        encryptedString:bool -> DataExplorerConnection
public abstract function FindConnection(
    provider : Guid, 
    connectionString : String, 
    encryptedString : boolean
) : DataExplorerConnection

Parameters

  • provider
    Type: System.Guid

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

  • connectionString
    Type: System.String

    An unencrypted or encrypted string containing connection information.

  • encryptedString
    Type: System.Boolean

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

Return Value

Type: Microsoft.VisualStudio.Data.DataExplorerConnection
Returns a DataExplorerConnection object instance representing the specified connection, or returns nulla null reference (Nothing in Visual Basic) if no such connection is found.

Exceptions

Exception Condition
ArgumentNullException

The connectionString parameter is null.

ArgumentException

The provider is not a registered DDEX provider.

.NET Framework Security

See Also

Reference

DataExplorerConnectionManager Class

FindConnection Overload

Microsoft.VisualStudio.Data Namespace