SqlConnectionStringBuilder.Remove(String) Método

Definición

Espacio de nombres:

Microsoft.Data.SqlClient

Ensamblado:

Microsoft.Data.SqlClient.dll

Paquete:

Microsoft.Data.SqlClient v5.2.0

Quita la entrada con la clave especificada de la instancia 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

Clave del par de clave-valor que se va a quitar de la cadena de conexión en este SqlConnectionStringBuilder.

Devoluciones

Boolean

true si la clave existía en la cadena de conexión y se quitó; false si la clave no existía.

Excepciones

ArgumentNullException

keyword es nulo (Nothing en Visual Basic).

Ejemplos

En el ejemplo siguiente una cadena de conexión existente pasa de utilizar autenticación de Windows a utilizar seguridad integrada. El ejemplo funciona quitando el nombre de usuario y la contraseña de la cadena de conexión y, a continuación, estableciendo la propiedad IntegratedSecurity del objeto SqlConnectionStringBuilder.

Nota:

Este ejempo incluye una contraseña para demostrar cómo SqlConnectionStringBuilder funciona con cadenas de conexión. Se recomienda que utilice autenticación de Windows en sus aplicaciones. Si necesita utilizar una contraseña en su aplicación, no incluya una contraseña codificada de forma rígida.

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

El ejemplo muestra el texto siguiente en la ventana de consola:

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  

Comentarios

Dado que el método Remove devuelve un valor que indica que se ha realizado correctamente, no es necesario buscar una clave antes de intentar quitar el par clave-valor de la SqlConnectionStringBuilder instancia. Ya que SqlConnectionStringBuilder mantiene una colección de tamaño fijo de pares clave-valor, llamando al método Remove restablece el valor del par clave-valor en su valor predeterminado.

Ya que la colección de claves compatibles con SqlConnectionStringBuilder es fija, cada elemento de la colección tiene un valor predeterminado conocido. La tabla siguiente enumera las claves y el valor de cada una cuanto se inicializa SqlConnectionStringBuilder por primera vez o después de llamar al método Remove.

Clave	Valor predeterminado
Nombre de la aplicación	"Proveedor de datos SqlClient de Microsoft Framework" al ejecutarse en .NET Framework. En caso contrario, "Proveedor de datos SqlClient principal de Microsoft".
AttachDBFilename	cadena vacía.
Tiempo de espera de la conexión	15
Conexión de contexto (obsoleta)	Falso
Idioma actual	cadena vacía.
Origen de datos	cadena vacía.
Cifrado	False en versiones anteriores a la versión 4.0, True en las versiones 4.0 y versiones posteriores
Dar de alta	Verdadero
Failover Partner	cadena vacía.
Catálogo original	cadena vacía.
Seguridad integrada	Falso
Tiempo de espera de equilibrio de carga	0
Max Pool Size	100
Min Pool Size	0
MultipleActiveResultSets	Falso
Biblioteca de red	cadena vacía.
Tamaño del paquete	8000
Contraseña	cadena vacía.
Persist Security Info	Falso
Agrupación	Verdadero
Replicación	Falso
Enlace por transacciones	Desenlace implícito
Id. de usuario	cadena vacía.
Instancia de usuario	Falso
Id. de estación de trabajo	cadena vacía.