SqlConnectionStringBuilder.Remove(String) Método

Definição

Namespace:

Microsoft.Data.SqlClient

Assembly:

Microsoft.Data.SqlClient.dll

Pacote:

Microsoft.Data.SqlClient v5.2.0

Remove a entrada com a chave especificada da instância de 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

Parâmetros

keyword

String

A chave do par chave/valor a ser removido da cadeia de conexão neste SqlConnectionStringBuilder.

Retornos

Boolean

true se a chave existia na cadeia de conexão e foi removida; false se a chave não existia.

Exceções

ArgumentNullException

keyword é nulo (Nothing no Visual Basic)

Exemplos

O exemplo a seguir converte uma cadeia de conexão existente de usando a Autenticação do Windows em usando a segurança integrada. O exemplo funciona removendo o nome de usuário e a senha da cadeia de conexão e definindo a IntegratedSecurity propriedade do SqlConnectionStringBuilder objeto.

Observação

Este exemplo inclui uma senha para demonstrar como SqlConnectionStringBuilder funciona com cadeias de conexão. Em seus aplicativos, recomendamos que você use a Autenticação do Windows. Se você precisar usar uma senha, não inclua uma senha embutida em código em seu aplicativo.

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();
    }
}

O exemplo exibe o seguinte texto na janela do console:

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  

Comentários

Como o método Remove retorna um valor que indica seu êxito, não é necessário procurar uma chave antes de tentar remover o par chave/valor da SqlConnectionStringBuilder instância. Como o SqlConnectionStringBuilder mantém uma coleção de tamanho fixo de pares chave/valor, chamar o Remove método simplesmente redefine o valor do par chave/valor de volta para seu valor padrão.

Como a coleção de chaves com suporte pelo SqlConnectionStringBuilder é fixa, cada item dentro da coleção tem um valor padrão conhecido. A tabela a seguir lista as chaves e o valor de cada quando o SqlConnectionStringBuilder é inicializado pela primeira vez ou depois que o Remove método é chamado.

Chave	Valor padrão
Nome do Aplicativo	"Provedor de Dados Framework Microsoft SqlClient" ao ser executado no .NET Framework. Caso contrário, "Provedor de Dados Principal do Microsoft SqlClient".
AttachDBFilename	cadeia de caracteres vazia
Tempo-limite da conexão	15
Context Connection(Obsolete)	Falso
Idioma Atual	cadeia de caracteres vazia
fonte de dados	cadeia de caracteres vazia
Encrypt	False em versões anteriores à 4.0, True nas versões 4.0 e posteriores
Alistar	Verdadeiro
Failover Partner	cadeia de caracteres vazia
Catálogo Inicial	cadeia de caracteres vazia
Segurança Integrada	Falso
Tempo limite do balanceamento de carga	0
Tamanho Máx do Pool	100
Tamanho mínimo do pool	0
MultipleActiveResultSets	Falso
Biblioteca de rede	cadeia de caracteres vazia
Tamanho do Pacote	8000
Senha	cadeia de caracteres vazia
Informações de Persistência de Segurança	Falso
Agrupamento	Verdadeiro
Replicação	Falso
Associação de transação	Desassociação implícita
Id de Usuário	cadeia de caracteres vazia
Instância do usuário	Falso
ID da Estação de Trabalho	cadeia de caracteres vazia