Share via


DataConnectionManager.InvalidateDataConnection Method

Invalidates a currently managed data connection that matches the specified connection information, if any.

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

Syntax

'Declaration
Public Sub InvalidateDataConnection ( _
    provider As Guid, _
    connectionString As String, _
    encryptedString As Boolean _
)
public void InvalidateDataConnection(
    Guid provider,
    string connectionString,
    bool encryptedString
)
public:
void InvalidateDataConnection(
    Guid provider, 
    String^ connectionString, 
    bool encryptedString
)
member InvalidateDataConnection : 
        provider:Guid * 
        connectionString:string * 
        encryptedString:bool -> unit 
public function InvalidateDataConnection(
    provider : Guid, 
    connectionString : String, 
    encryptedString : boolean
)

Parameters

  • provider
    Type: System.Guid
    A DDEX data provider GUID.
  • connectionString
    Type: System.String
    A connection string recognized by the data provider.
  • encryptedString
    Type: System.Boolean
    Indicates whether the connection string parameter is encrypted (true if encrypted).

Remarks

This method allows a client to indicate that a data connection currently being shared is known to no longer be valid. For example, a client feature that deletes a database file may invalidate any connections to that file. After invalidating the connection, the next client to request a data connection that matches this invalidated connection will get a new one rather than the invalidated one.

.NET Framework Security

See Also

Reference

DataConnectionManager Class

Microsoft.VisualStudio.Data Namespace