SqlConnectionStringBuilder.Remove(String) Метод

Определение

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

Microsoft.Data.SqlClient

Сборка:

Microsoft.Data.SqlClient.dll

Пакет:

Microsoft.Data.SqlClient v5.2.0

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

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

public override bool Remove (string keyword);

override this.Remove : string -> bool

Public Overrides Function Remove (keyword As String) As Boolean

Параметры

keyword

String

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

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

Boolean

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

Исключения

ArgumentNullException

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

Примеры

В следующем примере выполняется преобразование существующей строки подключения с использования аутентификации Windows на использование встроенной безопасности. В примере это выполняется путем удаления имени и пароля пользователя из строки подключения с последующим заданием значения свойства IntegratedSecurity объекта SqlConnectionStringBuilder.

Примечание

В этом примере для демонстрации взаимодействия класса SqlConnectionStringBuilder со строками подключения используется пароль. В приложениях рекомендуется использовать аутентификацию Windows. Если необходимо использовать пароль, то не следует включать в приложение пароли, жестко заданные в коде.

using Microsoft.Data.SqlClient;

class Program
{
    static void Main()
    {
        try
        {
            string connectString =
                "Data Source=(local);User ID=ab;Password= a1Pass@@11;" +
                "Initial Catalog=AdventureWorks";

            SqlConnectionStringBuilder builder = new SqlConnectionStringBuilder(connectString);
            Console.WriteLine("Original: " + builder.ConnectionString);

            // Use the Remove method
            // in order to reset the user ID and password back to their
            // default (empty string) values. 
            builder.Remove("User ID");
            builder.Remove("Password");

            // Turn on integrated security:
            builder.IntegratedSecurity = true;

            Console.WriteLine("Modified: " + builder.ConnectionString);

            using (SqlConnection
                       connection = new SqlConnection(builder.ConnectionString))
            {
                connection.Open();
                // Now use the open connection.
                Console.WriteLine("Database = " + connection.Database);
            }
        }
        catch (Exception ex)
        {
            Console.WriteLine(ex.Message);
        }

        Console.WriteLine("Press any key to finish.");
        Console.ReadLine();
    }
}

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

Original: Data Source=(local);Initial Catalog=AdventureWorks;User ID=ab;Password= a1Pass@@11  
Modified: Data Source=(local);Initial Catalog=AdventureWorks;Integrated Security=True  
Database = AdventureWorks  

Комментарии

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

Поскольку коллекция ключей, поддерживаемая классом SqlConnectionStringBuilder, фиксирована, каждый элемент в коллекции имеет известное значение по умолчанию. В следующей таблице перечисляются ключи, а также значения для каждого из них при первой инициализации класса SqlConnectionStringBuilder или после вызова метода Remove.

Ключ	Значение по умолчанию
Application Name	"Поставщик данных Платформы Microsoft SqlClient" при выполнении на платформа .NET Framework. "Основной поставщик данных Microsoft SqlClient" в противном случае.
AttachDBFilename	Пустая строка.
Connection Timeout	15
Контекстное соединение (устаревшее)	Неверно
Current Language	Пустая строка.
источника данных	Пустая строка.
Encrypt	False в версиях до 4.0, True в версиях 4.0 и более поздних
Enlist	Верно
Failover Partner	Пустая строка.
Initial Catalog	Пустая строка.
Integrated Security	Неверно
Load Balance Timeout	0
Max Pool Size	100
Min Pool Size	0
MultipleActiveResultSets	Неверно
Network Library	Пустая строка.
Packet Size	8000
Пароль	Пустая строка.
Сохранять сведения о безопасности	Неверно
Pooling	Верно
Replication	Неверно
Transaction Binding	Implicit Unbind
User ID	Пустая строка.
User Instance	Неверно
Workstation ID	Пустая строка.