OdbcConnectionStringBuilder Klasse

Definition

public ref class OdbcConnectionStringBuilder sealed : System::Data::Common::DbConnectionStringBuilder

public sealed class OdbcConnectionStringBuilder : System.Data.Common.DbConnectionStringBuilder

[System.ComponentModel.TypeConverter(typeof(System.Data.Odbc.OdbcConnectionStringBuilder+OdbcConnectionStringBuilderConverter))]
public sealed class OdbcConnectionStringBuilder : System.Data.Common.DbConnectionStringBuilder

type OdbcConnectionStringBuilder = class
    inherit DbConnectionStringBuilder

[<System.ComponentModel.TypeConverter(typeof(System.Data.Odbc.OdbcConnectionStringBuilder+OdbcConnectionStringBuilderConverter))>]
type OdbcConnectionStringBuilder = class
    inherit DbConnectionStringBuilder

Public NotInheritable Class OdbcConnectionStringBuilder
Inherits DbConnectionStringBuilder

Vererbung

Object

DbConnectionStringBuilder

OdbcConnectionStringBuilder

Attribute

TypeConverterAttribute

Beispiele

Die folgende Konsolenanwendung erstellt Verbindungszeichenfolgen für mehrere ODBC-Datenbanken. Zuerst erstellt das Beispiel eine Verbindungszeichenfolge für eine Microsoft Access-Datenbank. Anschließend wird eine Verbindungszeichenfolge für eine IBM DB2-Datenbank erstellt. Im Beispiel wird auch eine vorhandene Verbindungszeichenfolge analysiert und verschiedene Möglichkeiten zum Bearbeiten des Inhalts der Verbindungszeichenfolge veranschaulicht.

using System.Data.Odbc;

class Program
{
    static void Main()
    {
        OdbcConnectionStringBuilder builder = new()
            {
                Driver = "Microsoft Access Driver (*.mdb)"
            };

        // Call the Add method to explicitly add key/value
        // pairs to the internal collection.
        builder.Add("Dbq", "C:\\info.mdb");

        Console.WriteLine(builder.ConnectionString);
        Console.WriteLine();

        // Clear current values and reset known keys to their
        // default values.
        builder.Clear();

        // Pass the OdbcConnectionStringBuilder an existing
        // connection string, and you can retrieve and
        // modify any of the elements.
        builder.ConnectionString =
            "driver={IBM DB2 ODBC DRIVER};Database=SampleDB;" +
            "hostname=SampleServerName;port=SamplePortNum;" +
            "protocol=TCPIP";

        Console.WriteLine($"protocol = {builder["protocol"].ToString()}");
        Console.WriteLine();

        // Call the Remove method to remove items from
        // the collection of key/value pairs.
        builder.Remove("port");

        // Note that calling Remove on a nonexistent item does not
        // throw an exception.
        builder.Remove("BadItem");
        Console.WriteLine(builder.ConnectionString);
        Console.WriteLine();

        // Setting the indexer adds the associated value, if
        // necessary.
        builder["NewKey"] = "newValue";
        Console.WriteLine(builder.ConnectionString);
    }
}

Imports System.Data.Odbc

Module Module1
    Sub Main()
        Dim builder As New OdbcConnectionStringBuilder With {
            .Driver = "Microsoft Access Driver (*.mdb)"
        }

        ' Call the Add method to explicitly add key/value
        ' pairs to the internal collection.
        builder.Add("Dbq", "C:\info.mdb")

        Console.WriteLine(builder.ConnectionString)
        Console.WriteLine()

        ' Clear current values and reset known keys to their
        ' default values.
        builder.Clear()

        ' Pass the OdbcConnectionStringBuilder an existing
        ' connection string, and you can retrieve and
        ' modify any of the elements.
        builder.ConnectionString =
            "driver={IBM DB2 ODBC DRIVER};Database=SampleDB;" &
            "hostname=SampleServerName;port=SamplePortNum;" &
            "protocol=TCPIP"

        Console.WriteLine("protocol = " & builder("protocol").ToString())
        Console.WriteLine()

        ' Call the Remove method to remove items from
        ' the collection of key/value pairs.
        builder.Remove("port")

        ' Note that calling Remove on a nonexistent item does not
        ' throw an exception.
        builder.Remove("BadItem")
        Console.WriteLine(builder.ConnectionString)
        Console.WriteLine()

        ' The Item property is the default for the class,
        ' and setting the Item property adds the value, if
        ' necessary.
        builder("NewKey") = "newValue"
        Console.WriteLine(builder.ConnectionString)

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

Hinweise

Mit den Verbindungszeichenfolgen-Generatoren können Entwickler syntaktisch korrekte Verbindungszeichenfolgen programmgesteuert erstellen und vorhandene Verbindungszeichenfolgen mithilfe von Eigenschaften und Methoden der Klasse analysieren und neu erstellen. Der Verbindungszeichenfolgen-Generator stellt stark typierte Eigenschaften bereit, die den bekannten Schlüssel-Wert-Paaren entsprechen, die von ODBC-Verbindungen zulässig sind, und Entwickler können beliebige Schlüssel-Wert-Paare für alle anderen Verbindungszeichenfolgenwerte hinzufügen.

Entwickler, die verbindungszeichenfolgen als Teil von Anwendungen erstellen müssen, können die OdbcConnectionStringBuilder Klasse verwenden, um Verbindungszeichenfolgen zu erstellen und zu ändern. Die Klasse erleichtert auch die Verwaltung von Verbindungszeichenfolgen, die in einer Anwendungskonfigurationsdatei gespeichert sind. OdbcConnectionStringBuilder führt nur Prüfungen für den begrenzten Satz bekannter Schlüssel/Wert-Paare durch. Daher kann diese Klasse verwendet werden, um ungültige Verbindungszeichenfolgen zu erstellen. In der folgenden Tabelle sind die spezifischen bekannten Schlüssel zusammen mit den entsprechenden Eigenschaften innerhalb der OdbcConnectionStringBuilder Klasse und deren Standardwerten aufgeführt. Neben diesen spezifischen Werten können Entwickler der Auflistung, die in der OdbcConnectionStringBuilder Instanz enthalten ist, beliebige Schlüssel-Wert-Paare hinzufügen.

Wenn ein Beliebiger Wert (außer dem Driver Wert) innerhalb der Verbindungszeichenfolge ein Semikolon (;)) enthält, wird der OdbcConnectionStringBuilder Wert in anführungszeichen in der Verbindungszeichenfolge eingeschlossen. Um dieses Problem mit dem Wert zu vermeiden, der Driver häufig ein Semikolon enthält, wird dieser Wert von der OdbcConnectionStringBuilder Klasse immer in geschweifte Klammern eingeschlossen. Die ODBC-Spezifikation gibt an, dass Treiberwerte, die Semikolons enthalten, mit geschweiften Klammern umgeben sein müssen, und diese Klasse behandelt dies für Sie.

Die Item[] Eigenschaft behandelt Versuche, bösartigen Code einzufügen. Der folgende Code wird z. B. mit der Standardeigenschaft Item[] (indexer in C#) dem geschachtelten Schlüssel-Wert-Paar ordnungsgemäß escapet.

Dim builder As _
 New System.Data.Odbc.OdbcConnectionStringBuilder
' Take advantage of the Driver property.
builder.Driver = "SQL Server"
builder("Server") = "MyServer;NewValue=Bad"
Console.WriteLine(builder.ConnectionString)

System.Data.Odbc.OdbcConnectionStringBuilder builder =
  new System.Data.Odbc.OdbcConnectionStringBuilder();
// Take advantage of the Driver property.
builder.Driver = "SQL Server";
builder["Server"] = "MyServer;NewValue=Bad";
Console.WriteLine(builder.ConnectionString);

Das Ergebnis ist die folgende Verbindungszeichenfolge, die den ungültigen Wert auf sichere Weise behandelt:

Driver={SQL Server};Server="MyServer;NewValue=Bad"

Weitere Informationen

• Verbindungszeichenfolgen-Generatoren
• Verbindungszeichenfolgen in ADO.NET