SqlConnectionStringBuilder.Remove(String) Methode

Definition

Entfernt den Eintrag mit dem angegebenen Schlüssel aus der SqlConnectionStringBuilder-Instanz.Removes the entry with the specified key from the SqlConnectionStringBuilder instance.

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

Parameter

keyword
String

Der Schlüssel des Schlüssel-Wert-Paars, das aus der Verbindungszeichenfolge in diesem SqlConnectionStringBuilder entfernt werden soll.The key of the key/value pair to be removed from the connection string in this SqlConnectionStringBuilder.

Gibt zurück

true, wenn der Schlüssel in der Verbindungszeichenfolge vorhanden war und entfernt wurde, false, wenn der Schlüssel nicht vorhanden war.true if the key existed within the connection string and was removed; false if the key did not exist.

Ausnahmen

keyword ist NULL (Nothing in Visual Basic).keyword is null (Nothing in Visual Basic)

Beispiele

Im folgenden Beispiel wird für eine vorhandene Verbindungszeichenfolge die Verwendung von integrierter Sicherheit anstelle von Windows-Authentifizierung festgelegt.The following example converts an existing connection string from using Windows Authentication to using integrated security. Dabei werden Benutzername und Kennwort aus der Verbindungszeichenfolge entfernt, und anschließend wird die IntegratedSecurity-Eigenschaft des SqlConnectionStringBuilder-Objekts festgelegt.The example works by removing the user name and password from the connection string, and then setting the IntegratedSecurity property of the SqlConnectionStringBuilder object.

Hinweis

Das Beispiel umfasst ein Kennwort zur Veranschaulichung der Funktion von SqlConnectionStringBuilder mit Verbindungszeichenfolgen.This example includes a password to demonstrate how SqlConnectionStringBuilder works with connection strings. In den Anwendungen wird die Verwendung der Windows-Authentifizierung empfohlen.In your applications, we recommend that you use Windows Authentication. Wenn Sie ein Kennwort verwenden müssen, schließen Sie kein hartcodiertes Kennwort in die Anwendung ein.If you must use a password, do not include a hard-coded password in your 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

Im Beispiel wird der folgende Text im Konsolenfenster angezeigt:The example displays the following text in the console window:

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  

Hinweise

Da die Remove -Methode einen Wert zurückgibt, der Ihren Erfolg angibt, ist es nicht erforderlich, nach einem Schlüssel zu suchen, bevor versucht wird, das Schlüssel-Wert-Paar aus der SqlConnectionStringBuilder-Instanz zu entfernen.Because the Remove method returns a value that indicates its success, it is not required to look for a key before trying to remove the key/value pair from the SqlConnectionStringBuilder instance. Da der SqlConnectionStringBuilder eine Sammlung von Schlüssel-Wert-Paaren mit fester Größe verwaltet, wird durch Aufrufen der Remove-Methode einfach der Wert des Schlüssel-Wert-Paares auf den Standardwert zurückgesetzt.Because the SqlConnectionStringBuilder maintains a fixed-size collection of key/value pairs, calling the Remove method simply resets the value of the key/value pair back to its default value.

Da die Sammlung der Schlüssel, die vom SqlConnectionStringBuilder unterstützt werden, repariert wurde, besitzt jedes Element in der Sammlung einen bekannten Standardwert.Because the collection of keys supported by the SqlConnectionStringBuilder is fixed, every item within the collection has a known default value. In der folgenden Tabelle ist neben den Schlüsseln auch der jeweilige Schlüsselwert aufgeführt, der bei der ersten Initialisierung von SqlConnectionStringBuilder oder nach dem Aufruf der Remove-Methode angegeben wird.The following table lists the keys, and the value for each when the SqlConnectionStringBuilder is first initialized, or after the Remove method has been called.

KeyKey StandardwertDefault value
Application NameApplication Name ".Net SqlClient Data Provider"".Net SqlClient Data Provider"
Asynchronous ProcessingAsynchronous Processing FalseFalse
AttachDBFilenameAttachDBFilename Leere ZeichenfolgeEmpty string
Connection TimeoutConnection Timeout 1515
Context ConnectionContext Connection FalseFalse
Current LanguageCurrent Language Leere ZeichenfolgeEmpty string
DatenquelleData Source Leere ZeichenfolgeEmpty string
EncryptEncrypt FalseFalse
EnlistEnlist TrueTrue
Failover PartnerFailover Partner Leere ZeichenfolgeEmpty string
Initial CatalogInitial Catalog Leere ZeichenfolgeEmpty string
Integrated SecurityIntegrated Security FalseFalse
Load Balance TimeoutLoad Balance Timeout 00
Max Pool SizeMax Pool Size 100100
Min Pool SizeMin Pool Size 00
MultipleActiveResultSetsMultipleActiveResultSets FalseFalse
Network LibraryNetwork Library Leere ZeichenfolgeEmpty string
Packet SizePacket Size 80008000
KennwortPassword Leere ZeichenfolgeEmpty string
Persist Security InfoPersist Security Info FalseFalse
PoolingPooling TrueTrue
ReplicationReplication FalseFalse
Transaktion BindingTransaction Binding Implicit UnbindImplicit Unbind
User IDUser ID Leere ZeichenfolgeEmpty string
User InstanceUser Instance FalseFalse
Workstation IDWorkstation ID Leere ZeichenfolgeEmpty string

Gilt für:

Siehe auch