OdbcConnectionStringBuilder Osztály

Definíció

Névtér:

System.Data.Odbc

Szerelvény:

System.Data.Odbc.dll

Csomag:

System.Data.Odbc v11.0.0-preview.5.26302.115

Forrás:

OdbcConnectionStringbuilder.cs

Egyszerű módot kínál az osztály által OdbcConnection használt kapcsolati sztringek tartalmának létrehozására és kezelésére.

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

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

type OdbcConnectionStringBuilder = class
    inherit DbConnectionStringBuilder

Public NotInheritable Class OdbcConnectionStringBuilder
Inherits DbConnectionStringBuilder

Öröklődés

Object

DbConnectionStringBuilder

OdbcConnectionStringBuilder

Példák

Az alábbi konzolalkalmazás kapcsolati sztringeket hoz létre több ODBC-adatbázishoz. A példa először létrehoz egy kapcsolati karakterlánc egy Microsoft Access-adatbázishoz. Ezután létrehoz egy kapcsolati karakterlánc egy IBM DB2-adatbázishoz. A példa egy meglévő kapcsolati karakterlánc is elemez, és bemutatja a kapcsolati karakterlánc tartalmának különböző manipulálási módjait.

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

Megjegyzések

A kapcsolati karakterlánc-szerkesztők lehetővé teszik a fejlesztők számára a szintaktikailag helyes kapcsolati sztringek létrehozását, valamint a meglévő kapcsolati sztringek elemzését és újraépítését az osztály tulajdonságainak és módszereinek használatával. A kapcsolati karakterlánc szerkesztő az ODBC-kapcsolatok által engedélyezett ismert kulcs-érték pároknak megfelelő, erősen gépelt tulajdonságokat biztosít, a fejlesztők pedig tetszőleges kulcs-érték párokat adhatnak hozzá bármely más kapcsolati karakterlánc értékhez.

Az alkalmazások részeként kapcsolati sztringeket létrehozó fejlesztők az OdbcConnectionStringBuilder osztály használatával hozhatnak létre és módosíthatnak kapcsolati sztringeket. Az osztály megkönnyíti az alkalmazáskonfigurációs fájlban tárolt kapcsolati sztringek kezelését is. OdbcConnectionStringBuilder csak az ismert kulcs/érték párok korlátozott készletét ellenőrzi. Ezért ez az osztály érvénytelen kapcsolati sztringek létrehozására használható. Az alábbi táblázat felsorolja az adott ismert kulcsokat az osztályon belüli megfelelő tulajdonságokkal és az OdbcConnectionStringBuilder alapértelmezett értékekkel együtt. Ezeken az értékeken kívül a fejlesztők bármilyen kulcs-/értékpárt hozzáadhatnak a OdbcConnectionStringBuilder példányban található gyűjteményhez.

Key	Ingatlan	Megjegyzés	Alapértelmezett érték
Driver	Driver	A fejlesztők nem tartalmazhatják az illesztőprogram nevét körülvevő zárójeleket a Driver tulajdonság beállításakor. A OdbcConnectionStringBuilder példány szükség szerint kapcsos zárójeleket ad hozzá.	Üres sztring
DSN	Dsn		Üres sztring

Ha a kapcsolati karakterlánc bármely értéke (a Driver értéken kívül) pontosvesszőt tartalmaz (;), a OdbcConnectionStringBuilder idézőjelekkel veszi körül az értéket a kapcsolati karakterlánc. A gyakran pontosvesszőt tartalmazó értékkel kapcsolatos Driver probléma elkerülése érdekében az osztály mindig kapcsos zárójelekkel veszi körül ezt az OdbcConnectionStringBuilder értéket. Az ODBC-specifikáció azt jelzi, hogy a pontosvesszőket tartalmazó illesztőprogram-értékeket kapcsos zárójelekkel kell körülvenni, és ez az osztály kezeli ezt az Ön számára.

A Item[] tulajdonság kezeli a rosszindulatú kód beszúrására tett kísérleteket. Az alábbi kód például az alapértelmezett Item[] tulajdonság (az indexelő C#-ban) használatával helyesen menekül a beágyazott kulcs/érték pártól.

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

Az eredmény a következő kapcsolati karakterlánc, amely biztonságosan kezeli az érvénytelen értéket:

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

Konstruktorok

Name	Description
OdbcConnectionStringBuilder()	Inicializálja a OdbcConnectionStringBuilder osztály új példányát.
OdbcConnectionStringBuilder(String)	Inicializálja a OdbcConnectionStringBuilder osztály új példányát. A megadott kapcsolati karakterlánc biztosítják a példány belső kapcsolati adatainak adatait.

Tulajdonságok

Name	Description
Driver	Lekéri vagy beállítja a kapcsolathoz társított ODBC-illesztőprogram nevét.
Dsn	Lekéri vagy beállítja a kapcsolathoz társított adatforrásnév (DSN) nevét.
Item[String]	Lekéri vagy beállítja a megadott kulccsal társított értéket. A C#-ban ez a tulajdonság az indexelő.
Keys	ICollection Lekéri azokat a kulcsokat, amelyek a OdbcConnectionStringBuilder.

Metódusok

Name	Description
Clear()	Törli a példány tartalmát OdbcConnectionStringBuilder .
ContainsKey(String)	Meghatározza, hogy a OdbcConnectionStringBuilder kulcs tartalmaz-e egy adott kulcsot.
Remove(String)	Eltávolítja a megadott kulccsal rendelkező bejegyzést a OdbcConnectionStringBuilder példányból.
TryGetValue(String, Object)	A megadott kulcsnak megfelelő értéket kér le ebből.OdbcConnectionStringBuilder

Lásd még

• Kapcsolati karakterlánc-generátorok
• Kapcsolati sztringek a ADO.NET