DataConnection.EquivalentTo Method

  • Article

Retrieves a Boolean value indicating whether or not information about the current connection is equivalent, in a design time sense, to the specified connection information.

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

Syntax

Public MustOverride Function EquivalentTo ( _
    provider As Guid, _
    connectionString As String, _
    encryptedString As Boolean _
) As Boolean

Dim instance As DataConnection
Dim provider As Guid
Dim connectionString As String
Dim encryptedString As Boolean
Dim returnValue As Boolean

returnValue = instance.EquivalentTo(provider, _
    connectionString, encryptedString)

public abstract bool EquivalentTo(
    Guid provider,
    string connectionString,
    bool encryptedString
)

public:
virtual bool EquivalentTo(
    Guid provider, 
    String^ connectionString, 
    bool encryptedString
) abstract

public abstract function EquivalentTo(
    provider : Guid, 
    connectionString : String, 
    encryptedString : boolean
) : boolean

Parameters

  • provider
    Type: System.Guid

    The unique identifier of a DDEX provider.

  • connectionString
    Type: System.String

    An unencrypted or encrypted provider-specific connection string.

  • encryptedString
    Type: System.Boolean

    Indication whether the connectionString parameter is unencrypted or encrypted. Provides true if encrypted.

Return Value

Type: System.Boolean

Returns true if the current connection's information is equivalent to connection information for the specified connection; otherwise returns false.

Remarks

This method is a convenience wrapper around the EquivalentTo method, sidestepping the need to manually create two DataConnectionProperties instances, configure both, and then call the EquivalentTo method on one of them, passing in the other.

Permissions

See Also

Reference

DataConnection Class

DataConnection Members

Microsoft.VisualStudio.Data Namespace

EquivalentTo