DbConnectionStringBuilder.Remove(String) Methode

Definition

Namespace:

System.Data.Common

Assembly:

System.Data.Common.dll

Quelle:

DbConnectionStringBuilder.cs

Entfernt den Eintrag mit dem angegebenen Schlüssel aus der DbConnectionStringBuilder-Instanz.

public:
 virtual bool Remove(System::String ^ keyword);

public virtual bool Remove (string keyword);

abstract member Remove : string -> bool
override this.Remove : string -> bool

Public Overridable Function Remove (keyword As String) As Boolean

Parameter

keyword

String

Der Schlüssel des Schlüssel-Wert-Paars, das aus der Verbindungszeichenfolge in diesem DbConnectionStringBuilder entfernt werden soll.

Gibt zurück

Boolean

true, wenn der Schlüssel in der Verbindungszeichenfolge vorhanden war und entfernt wurde, false, wenn der Schlüssel nicht vorhanden war.

Ausnahmen

ArgumentNullException

keyword ist NULL (Nothing in Visual Basic).

NotSupportedException

DbConnectionStringBuilder ist schreibgeschützt, oder DbConnectionStringBuilder hat eine feste Größe.

Beispiele

static void Main()
{
    DbConnectionStringBuilder builder = new
        DbConnectionStringBuilder();
    builder.ConnectionString =
        @"Provider=Microsoft.Jet.OLEDB.4.0;Data
            Source=C:\Demo.mdb;" +
        "Jet OLEDB:System Database=system.mdw;";

    // Try to remove an existing item.
    TryRemove(builder, "Provider");

    // Try to remove a nonexistent item.
    TryRemove(builder, "User ID");

    // Try to remove an existing item,
    // demonstrating that the search isn't
    // case sensitive.
    TryRemove(builder, "DATA SOURCE");
    Console.ReadLine();
}

static void TryRemove(DbConnectionStringBuilder builder, string itemToRemove)
{
    if (builder.Remove(itemToRemove))
    {
        Console.WriteLine(@"Removed '{0}'", itemToRemove);
    }
    else
    {
        Console.WriteLine(@"Unable to remove '{0}'", itemToRemove);
    }
    Console.WriteLine(builder.ConnectionString);
}

Sub Main()
    Dim builder As New DbConnectionStringBuilder
    builder.ConnectionString = _
        "Provider=Microsoft.Jet.OLEDB.4.0;Data Source=C:\Demo.mdb;" & _
        "Jet OLEDB:System Database=system.mdw;"

    ' Try to remove an existing item.
    TryRemove(builder, "Provider")

    ' Try to remove a nonexistent item.
    TryRemove(builder, "User ID")

    ' Try to remove an existing item, 
    ' demonstrating that the search isn't 
    ' case sensitive.
    TryRemove(builder, "DATA SOURCE")
    Console.ReadLine()
End Sub

Sub TryRemove(ByVal builder As DbConnectionStringBuilder, _
    ByVal itemToRemove As String)

    If builder.Remove(itemToRemove) Then
        Console.WriteLine("Removed '{0}'", itemToRemove)
    Else
        Console.WriteLine("Unable to remove '{0}'", itemToRemove)
    End If
    Console.WriteLine(builder.ConnectionString)
End Sub

In diesem Beispiel wird die folgende Ausgabe angezeigt:

Removed 'Provider'
data source=C:\Demo.mdb;jet oledb:system database=system.mdw
Unable to remove 'User ID'
data source=C:\Demo.mdb;jet oledb:system database=system.mdw
Removed 'DATA SOURCE'
jet oledb:system database=system.mdw

Hinweise

Da die Remove Methode einen Wert zurückgibt, der seinen Erfolg angibt, ist es nicht erforderlich, nach dem Schlüssel zu suchen, bevor versucht wird, das Schlüssel-Wert-Paar aus dem DbConnectionStringBuilder instance zu entfernen.

Weitere Informationen

• Verbindungszeichenfolgen in ADO.NET
• Übersicht über ADO.NET