DbConnectionStringBuilder.Remove(String) Метод

Определение

Удаляет из экземпляра DbConnectionStringBuilder запись с указанным ключом.Removes the entry with the specified key from the DbConnectionStringBuilder instance.

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.The key of the key/value pair to be removed from the connection string in this DbConnectionStringBuilder.

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

Boolean

Значение true, если ключ был указан в строке подключения и был удален. Значение false, если такого ключа не было.true if the key existed within the connection string and was removed; false if the key did not exist.

Исключения

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

DbConnectionStringBuilder доступен только для чтения, или DbConnectionStringBuilder имеет фиксированный размер.The DbConnectionStringBuilder is read-only, or the DbConnectionStringBuilder has a fixed size.

Примеры

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

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

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 .Because the Remove method returns a value that indicates its success, it is not required to look for the key before trying to remove the key/value pair from the DbConnectionStringBuilder instance.

Применяется к

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