OleDbConnectionStringBuilder Classe

Définition

Espace de noms:

System.Data.OleDb

Assembly:

System.Data.OleDb.dll

Paquet:

System.Data.OleDb v9.0.0-rc.2.24473.5

Source:

OleDbConnectionStringBuilder.cs

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

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

[System.ComponentModel.TypeConverter(typeof(System.Data.OleDb.OleDbConnectionStringBuilder+OleDbConnectionStringBuilderConverter))]
public sealed class OleDbConnectionStringBuilder : System.Data.Common.DbConnectionStringBuilder

[<System.ComponentModel.TypeConverter(typeof(System.Data.OleDb.OleDbConnectionStringBuilder+OleDbConnectionStringBuilderConverter))>]
type OleDbConnectionStringBuilder = class
    inherit DbConnectionStringBuilder

Public NotInheritable Class OleDbConnectionStringBuilder
Inherits DbConnectionStringBuilder

Héritage

Object

DbConnectionStringBuilder

OleDbConnectionStringBuilder

Attributs

TypeConverterAttribute

Exemples

L’application console suivante génère des chaînes de connexion pour plusieurs bases de données OLE DB. Tout d’abord, l’exemple crée un chaîne de connexion pour une base de données Microsoft Access, puis crée 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 OleDbConnectionStringBuilder 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.OleDb;

class Program
{
    static void Main(string[] args)
    {
        OleDbConnectionStringBuilder builder = new OleDbConnectionStringBuilder();
        builder.ConnectionString = @"Data Source=C:\Sample.mdb";

        // Call the Add method to explicitly add key/value
        // pairs to the internal collection.
        builder.Add("Provider", "Microsoft.Jet.Oledb.4.0");
        builder.Add("Jet OLEDB:Database Password", "MyPassword!");
        builder.Add("Jet OLEDB:System Database", @"C:\Workgroup.mdb");

        // Set up row-level locking.
        builder.Add("Jet OLEDB:Database Locking Mode", 1);

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

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

        // Pass the OleDbConnectionStringBuilder an existing
        // connection string, and you can retrieve and
        // modify any of the elements.
        builder.ConnectionString =
            "Provider=DB2OLEDB;Network Transport Library=TCPIP;" +
            "Network Address=192.168.0.12;Initial Catalog=DbAdventures;" +
            "Package Collection=SamplePackage;Default Schema=SampleSchema;";

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

        // Modify existing items.
        builder["Package Collection"] = "NewPackage";
        builder["Default Schema"] = "NewSchema";

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

        // 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 value, if
        // necessary.
        builder["User ID"] = "SampleUser";
        builder["Password"] = "SamplePassword";
        Console.WriteLine(builder.ConnectionString);

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

Imports System.Data.OleDb    
Imports System.Collections

Module Module1
  Sub Main()
    Dim builder As New OleDbConnectionStringBuilder()
    builder.ConnectionString = "Data Source=C:\Sample.mdb"

    ' Call the Add method to explicitly add key/value
    ' pairs to the internal collection.
    builder.Add("Provider", "Microsoft.Jet.Oledb.4.0")
    builder.Add("Jet OLEDB:Database Password", "MyPassword!")
    builder.Add("Jet OLEDB:System Database", "C:\Workgroup.mdb")

    ' Set up row-level locking.
    builder.Add("Jet OLEDB:Database Locking Mode", 1)

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

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

    ' Pass the OleDbConnectionStringBuilder an existing 
    ' connection string, and you can retrieve and
    ' modify any of the elements.
    builder.ConnectionString = _
        "Provider=DB2OLEDB;Network Transport Library=TCPIP;" & _
        "Network Address=192.168.0.12;Initial Catalog=DbAdventures;" & _
        "Package Collection=SamplePackage;Default Schema=SampleSchema;"

    Console.WriteLine("Network Address = " & builder("Network Address").ToString())
    Console.WriteLine()

    ' Modify existing items.
    builder("Package Collection") = "NewPackage"
    builder("Default Schema") = "NewSchema"

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

    ' 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("User ID") = "SampleUser"
    builder("Password") = "SamplePassword"
    Console.WriteLine(builder.ConnectionString)

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

Remarques

Le générateur de chaînes de connexion permet aux développeurs de créer par programme des chaînes de connexion correctes du point de vue de la syntaxe, et d'analyser et régénérer des chaînes de connexion existantes, à l'aide de propriétés et de 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 OLE DB, et les développeurs peuvent ajouter des paires clé/valeur arbitraires pour toutes les autres valeurs chaîne de connexion. La classe OleDbConnectionStringBuilder implémente l’interface ICustomTypeDescriptor. Cela signifie que la classe fonctionne avec les concepteurs Visual Studio .NET au moment de la conception. Lorsque les développeurs utilisent le concepteur pour créer des DataSets fortement typés et des connexions fortement typées dans Visual Studio .NET, la classe de générateur fortement typée chaîne de connexion affiche les propriétés associées à son type et a également des convertisseurs qui peuvent mapper des valeurs courantes pour les clés connues.

Les développeurs ayant besoin de créer des chaînes de connexion dans le cadre d'applications peuvent utiliser la classe OleDbConnectionStringBuilder 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. Effectue OleDbConnectionStringBuilder 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 et leurs propriétés correspondantes au sein de la OleDbConnectionStringBuilder classe, ainsi que leurs valeurs par défaut. Outre ces valeurs spécifiques, les développeurs peuvent ajouter n’importe quelle paire clé/valeur à la collection contenue dans le OleDbConnectionStringBuilder instance :

Clé	Propriété	Valeur par défaut
Nom de fichier	FileName	""
Fournisseur	Provider	""
source de données	DataSource	""
Persist Security Info	PersistSecurityInfo	Faux
OLE DB Services	OleDbServices	-13

La Item[] propriété gère les tentatives d’insertion d’entrées malveillantes. 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.OleDb.OleDbConnectionStringBuilder
builder("Provider") = "Microsoft.Jet.OLEDB.4.0"
builder("Data Source") = "C:\Sample.mdb"
builder("User Id") = "Admin;NewValue=Bad"

System.Data.OleDb.OleDbConnectionStringBuilder builder =
    new System.Data.OleDb.OleDbConnectionStringBuilder();
builder["Provider"] = "Microsoft.Jet.OLEDB.4.0";
builder["Data Source"] = "C:\\Sample.mdb";
builder["User Id"] = "Admin;NewValue=Bad";

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

Provider=Microsoft.Jet.OLEDB.4.0;Data Source=C:\Sample.mdb;User ID="Admin;NewValue=Bad"

Constructeurs

OleDbConnectionStringBuilder()	Initialise une nouvelle instance de la classe OleDbConnectionStringBuilder.
OleDbConnectionStringBuilder(String)	Initialise une nouvelle instance de la classe OleDbConnectionStringBuilder. 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)
DataSource	Obtient ou définit le nom de la source de données à laquelle se connecter.
FileName	Obtient ou définit le nom du fichier UDL (Universal Data Link) pour se connecter à la source de données.
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 OleDbConnectionStringBuilder.
OleDbServices	Obtient ou définit la valeur à passer pour la clé OLE DB Services dans la chaîne de connexion.
PersistSecurityInfo	Obtient ou définit une valeur Boolean qui indique si les informations de sécurité, telles que le mot de passe, sont retournées dans le cadre de la connexion si celle-ci est ouverte ou l'a été à un moment donné.
Provider	Obtient ou définit une chaîne qui contient le nom du fournisseur de données associé à la chaîne de connexion interne.
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 OleDbConnectionStringBuilder.
ClearPropertyDescriptors()	Efface la collection d’objets PropertyDescriptor du DbConnectionStringBuilder associé. (Hérité de DbConnectionStringBuilder)
ContainsKey(String)	Détermine si OleDbConnectionStringBuilder 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 OleDbConnectionStringBuilder.
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 l'instance de OleDbConnectionStringBuilder.

Méthodes d’extension

Voir aussi

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