SqlConnectionStringBuilder.Remove(String) Méthode

Référence

Définition

Espace de noms:: System.Data.SqlClient

Assembly:: System.Data.SqlClient.dll

Assembly:: System.Data.dll

Paquet:: System.Data.SqlClient v4.8.6

Important

Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.

Supprime l'entrée contenant la clé spécifiée dans l'instance 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

Paramètres

keyword: String

Clé de la paire clé/valeur à supprimer de la chaîne de connexion dans SqlConnectionStringBuilder.

Retours

Boolean

true si la clé existait dans la chaîne de connexion et a été supprimée ; false si la clé n’existait pas.

Exceptions

ArgumentNullException

keyword a la valeur Null (Nothing en Visual Basic).

Exemples

L'exemple suivant convertit une chaîne de connexion existante qui utilise l'authentification Windows en une chaîne de connexion qui utilise la sécurité intégrée. Pour cela, l'exemple supprime le nom d'utilisateur et le mot de passe de la chaîne de connexion, puis définit la propriété IntegratedSecurity de l'objet SqlConnectionStringBuilder.

Notes

Cet exemple inclut un mot de passe pour illustrer l'utilisation de SqlConnectionStringBuilder avec les chaînes de connexion. Dans vos applications, nous vous recommandons d'utiliser l'authentification Windows. Si vous devez utiliser un mot de passe, n'incluez pas de mot de passe codé en dur dans votre application.

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

Imports System.Data.SqlClient
    
Module Module1
  Sub Main()
    Try
      Dim connectString As String = _
       "Data Source=(local);User ID=ab;Password=a1Pass@@11;" & _
       "Initial Catalog=AdventureWorks"

      Dim builder As 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 connection As New SqlConnection(builder.ConnectionString)
        connection.Open()
        ' Now use the open connection.
        Console.WriteLine("Database = " & connection.Database)
      End Using

    Catch ex As Exception
      Console.WriteLine(ex.Message)
    End Try

    Console.WriteLine("Press any key to finish.")
    Console.ReadLine()
  End Sub
End Module

L'exemple affiche le texte suivant dans la fenêtre de 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

Remarques

Étant donné que la méthode Remove retourne une valeur qui indique sa réussite, il n’est pas nécessaire de rechercher une clé avant d’essayer de supprimer la paire clé/valeur du SqlConnectionStringBuilder instance. Étant donnée que SqlConnectionStringBuilder conserve une collection de taille fixe de paires clé/valeur, l’appel à la méthode Remove rétablit simplement la valeur par défaut de la valeur de la paire clé/valeur.

Étant donné que la collection de clés prise en charge par SqlConnectionStringBuilder est fixe, chaque élément dans la collection a une valeur par défaut connue. Le tableau suivant répertorie les clés et la valeur de chacune lorsque SqlConnectionStringBuilder est initialisé pour la première fois ou après l'appel à la méthode Remove.

Clé	Valeur par défaut
Nom de l’application	« .Net SqlClient Data Provider »
Asynchronous Processing	Faux
AttachDBFilename	Chaîne vide
Délai de connexion	15
Connexion contextuelle	Faux
Langue actuelle	Chaîne vide
source de données	Chaîne vide
Encrypt (Chiffrer)	Faux
Enlist	Vrai
Failover Partner	Chaîne vide
Catalogue initial	Chaîne vide
Sécurité intégrée	Faux
Load Balance Timeout	0
Max Pool Size	100
Min Pool Size	0
MultipleActiveResultSets	Faux
Network Library	Chaîne vide
Taille du paquet	8000
Mot de passe	Chaîne vide
Persist Security Info	Faux
Pooling	Vrai
Réplication	Faux
Transaction Binding	Implicit Unbind
ID d'utilisateur	Chaîne vide
User Instance	Faux
ID Station de travail	Chaîne vide

S’applique à