OdbcConnectionStringBuilder Classe

Définition

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

Héritage

Object

DbConnectionStringBuilder

OdbcConnectionStringBuilder

Attributs

TypeConverterAttribute

Exemples

L’application console suivante génère des chaînes de connexion pour plusieurs bases de données ODBC. Tout d’abord, l’exemple crée un chaîne de connexion pour une base de données Microsoft Access. Il crée ensuite un chaîne de connexion pour une base de données IBM DB2. L’exemple analyse également une chaîne de connexion existante et montre différentes façons de manipuler le contenu du chaîne de connexion.

using System.Data.Odbc;

class Program
{
    static void Main()
    {
        OdbcConnectionStringBuilder builder =
            new OdbcConnectionStringBuilder();
        builder.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");
        builder.Add("Uid", "Admin");
        builder.Add("Pwd", "pass!word1");

        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;uid=Admin;pwd=pass!word1";

        Console.WriteLine("protocol = "
            + builder["protocol"].ToString());
        Console.WriteLine();

        // Modify existing items.
        builder["uid"] = "NewUser";
        builder["pwd"] = "Pass@word2";

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

        Console.WriteLine("Press Enter to finish.");
        Console.ReadLine();
    }
}

Imports System.Data.Odbc    

Module Module1
  Sub Main()
    Dim builder As New OdbcConnectionStringBuilder()
    builder.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")
    builder.Add("Uid", "Admin")
    builder.Add("Pwd", "pass!word1")

    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;uid=Admin;pwd=pass!word1"

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

    ' Modify existing items:
    builder("uid") = "NewUser"
    builder("pwd") = "Pass@word2"

    ' 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

Remarques

Les générateurs chaîne de connexion permettent aux développeurs de créer par programmation des chaînes de connexion correctes syntaxiquement, puis d’analyser et de reconstruire les chaînes de connexion existantes, à l’aide des propriétés et des méthodes de la classe . Le générateur chaîne de connexion fournit des propriétés fortement typées correspondant aux paires clé/valeur connues autorisées par les connexions ODBC, et les développeurs peuvent ajouter des paires clé/valeur arbitraires pour toutes les autres valeurs chaîne de connexion.

Les développeurs ayant besoin de créer des chaînes de connexion dans le cadre d'applications peuvent utiliser la classe OdbcConnectionStringBuilder pour générer et modifier des chaînes de connexion. Cette classe permet également de gérer facilement les chaînes de connexion stockées dans un fichier de configuration de l'application. OdbcConnectionStringBuilder effectue des vérifications uniquement pour l’ensemble limité de paires clé/valeur connues. Par conséquent, cette classe peut être utilisée pour créer des chaînes de connexion non valides. Le tableau suivant répertorie les clés connues spécifiques, ainsi que leurs propriétés correspondantes dans la OdbcConnectionStringBuilder classe et leurs valeurs par défaut. Outre ces valeurs spécifiques, les développeurs peuvent ajouter toutes les paires clé/valeur à la collection contenue dans le OdbcConnectionStringBuilder instance.

Si une valeur (autre que la Driver valeur) dans le chaîne de connexion contient un point-virgule (;), le OdbcConnectionStringBuilder entoure de guillemets dans le chaîne de connexion. Pour éviter ce problème avec la Driver valeur qui contient fréquemment un point-virgule, la OdbcConnectionStringBuilder classe entoure toujours cette valeur d’accolades. La spécification ODBC indique que les valeurs de pilote qui contiennent des points-virgules doivent être entourées d’accolades, et cette classe gère cela pour vous.

La Item[] propriété gère les tentatives d’insertion de code malveillant. Par exemple, le code suivant, à l’aide de la propriété par défaut Item[] (l’indexeur, en C#) échappe correctement la paire clé/valeur imbriquée.

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

Le résultat est la chaîne de connexion suivante qui gère la valeur non valide de manière sécurisée.

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

Constructeurs

Propriétés

Méthodes

Implémentations d’interfaces explicites

Méthodes d’extension

S’applique à

Voir aussi

• Builders de chaînes de connexion
• Chaînes de connexion dans ADO.NET