OdbcConnectionStringBuilder Klas

Definitie

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

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

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

Public NotInheritable Class OdbcConnectionStringBuilder
Inherits DbConnectionStringBuilder

Overname

Object

DbConnectionStringBuilder

OdbcConnectionStringBuilder

Kenmerken

TypeConverterAttribute

Voorbeelden

De volgende consoletoepassing bouwt verbindingsreeksen voor verschillende ODBC-databases. Eerst maakt het voorbeeld een verbindingsreeks voor een Microsoft Access-database. Vervolgens wordt er een verbindingsreeks gemaakt voor een IBM DB2-database. Het voorbeeld parseert ook een bestaande verbindingsreeks en demonstreert verschillende manieren om de inhoud van de verbindingsreeks te bewerken.

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

Opmerkingen

Met de verbindingsreeks opbouwfuncties kunnen ontwikkelaars programmatisch syntactisch juiste verbindingsreeksen maken en bestaande verbindingsreeksen parseren en herbouwen, met behulp van eigenschappen en methoden van de klasse. De verbindingsreeks builder biedt sterk getypte eigenschappen die overeenkomen met de bekende sleutel-/waardeparen die zijn toegestaan door ODBC-verbindingen en ontwikkelaars kunnen willekeurige sleutel-/waardeparen toevoegen voor andere verbindingsreeks-waarden.

Ontwikkelaars die verbindingsreeksen moeten maken als onderdeel van toepassingen, kunnen de OdbcConnectionStringBuilder klasse gebruiken om verbindingsreeksen te bouwen en te wijzigen. De klasse maakt het ook eenvoudig om verbindingsreeksen te beheren die zijn opgeslagen in een toepassingsconfiguratiebestand. OdbcConnectionStringBuilder voert alleen controles uit voor de beperkte set bekende sleutel-/waardeparen. Daarom kan deze klasse worden gebruikt om ongeldige verbindingsreeksen te maken. De volgende tabel bevat de specifieke bekende sleutels samen met de bijbehorende eigenschappen binnen de OdbcConnectionStringBuilder klasse en de standaardwaarden. Naast deze specifieke waarden kunnen ontwikkelaars alle sleutel-/waardeparen toevoegen aan de verzameling die zich in het OdbcConnectionStringBuilder exemplaar bevindt.

Als een waarde (behalve de Driver waarde) in de verbindingsreeks een puntkomma (;) bevat, bevat de OdbcConnectionStringBuilder de waarde tussen aanhalingstekens in de verbindingsreeks. Om dit probleem te voorkomen met de Driver waarde die vaak een puntkomma bevat, plaatst de OdbcConnectionStringBuilder klasse deze waarde altijd tussen accolades. De ODBC-specificatie geeft aan dat stuurprogrammawaarden met puntkomma's moeten worden omgeven door accolades en deze klasse verwerkt dit voor u.

De Item[] eigenschap verwerkt pogingen om schadelijke code in te voegen. De volgende code, met behulp van de standaardeigenschap Item[] (de indexeerfunctie, in C#), escapet bijvoorbeeld correct aan het geneste sleutel-/waardepaar.

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

Het resultaat is de volgende verbindingsreeks die de ongeldige waarde op een veilige manier verwerkt:

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

Zie ook

• Opbouwers voor connectiestrings
• Verbindingsreeksen in ADO.NET