DbConnectionStringBuilder.Remove(String) Метод

Определение

Пространство имен:

System.Data.Common

Сборка:

System.Data.Common.dll

Исходный код:

DbConnectionStringBuilder.cs

Удаляет из экземпляра DbConnectionStringBuilder запись с указанным ключом.

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

Параметры

keyword

String

Ключ пары «ключ-значение», удаляемой из строки подключения в этом объекте DbConnectionStringBuilder.

Возвращаемое значение

Boolean

Значение true, если ключ был указан в строке подключения и был удален. Значение false, если такого ключа не было.

Исключения

ArgumentNullException

Параметр keyword является пустой ссылкой (Nothing в Visual Basic).

NotSupportedException

DbConnectionStringBuilder доступен только для чтения, или DbConnectionStringBuilder имеет фиксированный размер.

Примеры

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

В этом примере отображаются следующие выходные данные:

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

Комментарии

Remove Так как метод возвращает значение, указывающее на его успешное выполнение, не требуется искать ключ, прежде чем пытаться удалить пару "ключ-значение" из экземпляраDbConnectionStringBuilder.

См. также раздел

• Строки подключения в ADO.NET
• Общие сведения об ADO.NET