OleDbConnectionStringBuilder Klas

Definitie

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

Overname

Object

DbConnectionStringBuilder

OleDbConnectionStringBuilder

Kenmerken

TypeConverterAttribute

Voorbeelden

De volgende consoletoepassing bouwt verbindingsreeksen voor verschillende OLE DB-databases. Eerst maakt het voorbeeld een verbindingsreeks voor een Microsoft Access-database en maakt vervolgens een verbindingsreeks 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.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 = "..."

    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

Opmerkingen

Met de opbouwfunctie voor verbindingsreeks 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 OLE DB-verbindingen en ontwikkelaars kunnen willekeurige sleutel-/waardeparen toevoegen voor andere verbindingsreeks-waarden. Met de klasse OleDbConnectionStringBuilder wordt de ICustomTypeDescriptor-interface geïmplementeerd. Dit betekent dat de klas werkt met Visual Studio .NET ontwerpers tijdens het ontwerpen. Wanneer ontwikkelaars de ontwerpfunctie gebruiken om sterk getypte DataSets en sterk getypte verbindingen binnen Visual Studio .NET te bouwen, worden in de sterk getypte klasse verbindingsreeks builder de eigenschappen weergegeven die zijn gekoppeld aan het type en worden ook conversieprogramma's weergegeven die algemene waarden voor bekende sleutels kunnen toewijzen.

Ontwikkelaars die verbindingsreeksen moeten maken als onderdeel van toepassingen, kunnen de OleDbConnectionStringBuilder 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. De OleDbConnectionStringBuilder 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 bekende sleutels en de bijbehorende eigenschappen binnen de OleDbConnectionStringBuilder klasse en hun standaardwaarden. Naast deze specifieke waarden kunnen ontwikkelaars alle sleutel-/waardeparen toevoegen aan de verzameling die zich in het OleDbConnectionStringBuilder exemplaar bevindt:

De Item[] eigenschap verwerkt pogingen om schadelijke vermeldingen 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.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";

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

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

Zie ook

• Opbouwers voor connectiestrings
• Verbindingsreeksen in ADO.NET