OdbcConnectionStringBuilder Classe

Définition

Espace de noms:

System.Data.Odbc

Assembly:

System.Data.Odbc.dll

Paquet:

System.Data.Odbc v8.0.0

Source:

OdbcConnectionStringbuilder.cs

Fournit un moyen simple de créer et de gérer le contenu de chaînes de connexion utilisées par la classe OdbcConnection.

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

Héritage

Object

DbConnectionStringBuilder

OdbcConnectionStringBuilder

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.

Notes

Cet exemple inclut un mot de passe pour illustrer l'utilisation de OdbcConnectionStringBuilder avec les chaînes de connexion. Dans vos applications, nous vous recommandons d'utiliser l'authentification Windows. Si vous devez utiliser un mot de passe, n'incluez pas de mot de passe codé en dur dans votre application.

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.

Clé	Propriété	Commentaire	Valeur par défaut
Pilote	Driver	Les développeurs ne doivent pas inclure les accolades entourant le nom du pilote lorsqu’ils définissent la Driver propriété. Le OdbcConnectionStringBuilder instance ajoute des accolades en fonction des besoins.	Chaîne vide
DSN	Dsn		Chaîne vide

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

OdbcConnectionStringBuilder()	Initialise une nouvelle instance de la classe OdbcConnectionStringBuilder.
OdbcConnectionStringBuilder(String)	Initialise une nouvelle instance de la classe OdbcConnectionStringBuilder. La chaîne de connexion spécifiée fournit les données pour les informations de connexion internes de l'instance.

Propriétés

BrowsableConnectionString	Obtient ou définit une valeur qui indique si la propriété ConnectionString est visible dans les concepteurs Visual Studio. (Hérité de DbConnectionStringBuilder)
ConnectionString	Obtient ou définit la chaîne de connexion associée au DbConnectionStringBuilder. (Hérité de DbConnectionStringBuilder)
Count	Obtient le nombre actuel de clés contenues dans la propriété ConnectionString. (Hérité de DbConnectionStringBuilder)
Driver	Obtient ou définit le nom du pilote ODBC associé à la connexion.
Dsn	Obtient ou définit le nom de source de données (DSN) associé à la connexion.
IsFixedSize	Obtient une valeur qui indique si DbConnectionStringBuilder est de taille fixe. (Hérité de DbConnectionStringBuilder)
IsReadOnly	Obtient une valeur qui indique si l’objet DbConnectionStringBuilder est en lecture seule. (Hérité de DbConnectionStringBuilder)
Item[String]	Obtient ou définit la valeur associée à la clé spécifiée. En C#, cette propriété est l'indexeur.
Keys	Obtient un ICollection qui contient les clés de OdbcConnectionStringBuilder.
Values	Obtient un objet ICollection qui contient les valeurs de l'objet DbConnectionStringBuilder. (Hérité de DbConnectionStringBuilder)

Méthodes

Add(String, Object)	Ajoute une entrée avec la clé et la valeur spécifiées dans DbConnectionStringBuilder. (Hérité de DbConnectionStringBuilder)
Clear()	Efface le contenu de l'instance OdbcConnectionStringBuilder.
ClearPropertyDescriptors()	Efface la collection d’objets PropertyDescriptor du DbConnectionStringBuilder associé. (Hérité de DbConnectionStringBuilder)
ContainsKey(String)	Détermine si OdbcConnectionStringBuilder contient une clé spécifique.
Equals(Object)	Détermine si l'objet spécifié est égal à l'objet actuel. (Hérité de Object)
EquivalentTo(DbConnectionStringBuilder)	Compare les informations de connexion de cet objet DbConnectionStringBuilder avec les informations de connexion de l’objet fourni. (Hérité de DbConnectionStringBuilder)
GetHashCode()	Fait office de fonction de hachage par défaut. (Hérité de Object)
GetProperties(Hashtable)	Remplit un Hashtable fourni avec des informations sur toutes les propriétés de ce DbConnectionStringBuilder. (Hérité de DbConnectionStringBuilder)
GetType()	Obtient le Type de l'instance actuelle. (Hérité de Object)
MemberwiseClone()	Crée une copie superficielle du Object actuel. (Hérité de Object)
Remove(String)	Supprime l'entrée contenant la clé spécifiée dans l'instance de OdbcConnectionStringBuilder.
ShouldSerialize(String)	Indique si la clé spécifiée existe dans cette instance de DbConnectionStringBuilder. (Hérité de DbConnectionStringBuilder)
ToString()	Retourne la chaîne de connexion associée à ce DbConnectionStringBuilder. (Hérité de DbConnectionStringBuilder)
TryGetValue(String, Object)	Récupère une valeur correspondant à la clé fournie à partir de cet objet OdbcConnectionStringBuilder.

Méthodes d’extension

Voir aussi

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