OleDbConnectionStringBuilder Klasse

Definition

Bietet eine einfache Möglichkeit, den Inhalt von Verbindungszeichenfolgen, die von der OleDbConnection-Klasse verwendet werden, zu erstellen und zu verwalten.Provides a simple way to create and manage the contents of connection strings used by the OleDbConnection class.

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
type OleDbConnectionStringBuilder = class
    inherit DbConnectionStringBuilder
Public NotInheritable Class OleDbConnectionStringBuilder
Inherits DbConnectionStringBuilder
Vererbung
OleDbConnectionStringBuilder
Attribute

Beispiele

Mit der folgenden Konsolenanwendung werden Verbindungs Zeichenfolgen für mehrere OLE DB Datenbanken erstellt.The following console application builds connection strings for several OLE DB databases. Zunächst wird im Beispiel eine Verbindungs Zeichenfolge für eine Microsoft Access-Datenbank erstellt, und anschließend wird eine Verbindungs Zeichenfolge für eine IBM DB2-Datenbank erstellt.First, the example creates a connection string for a Microsoft Access database, and then creates a connection string for an IBM DB2 database. Im Beispiel wird auch eine vorhandene Verbindungs Zeichenfolge analysiert, und es werden verschiedene Möglichkeiten zum Bearbeiten der Inhalte der Verbindungs Zeichenfolge veranschaulicht.The example also parses an existing connection string, and demonstrates various ways of manipulating the connection string's contents.

Hinweis

Das Beispiel umfasst ein Kennwort zur Veranschaulichung der Funktion von OleDbConnectionStringBuilder mit Verbindungszeichenfolgen.This example includes a password to demonstrate how OleDbConnectionStringBuilder works with connection strings. In den Anwendungen wird die Verwendung der Windows-Authentifizierung empfohlen.In your applications, we recommend that you use Windows Authentication. Wenn Sie ein Kennwort verwenden müssen, schließen Sie kein hartcodiertes Kennwort in die Anwendung ein.If you must use a password, do not include a hard-coded password in your 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

Hinweise

Mithilfe des Verbindungszeichenfolgen-Generators können Entwickler syntaktisch korrekte Verbindungszeichenfolgen programmgesteuert erstellen sowie vorhandene Verbindungszeichenfolgen analysieren und neu erstellen, indem sie Eigenschaften und Methoden der Klasse verwenden.The connection string builder lets developers programmatically create syntactically correct connection strings, and parse and rebuild existing connection strings, using properties and methods of the class. Der Verbindungs Zeichenfolgen-Generator stellt stark typisierte Eigenschaften bereit, die den bekannten Schlüssel-Wert-Paaren entsprechen, die OLE DB Verbindungen zulässig sind, und Entwickler können beliebige Schlüssel-Wert-Paare für alle anderen Verbindungs Zeichen folgen Werte hinzufügen.The connection string builder provides strongly typed properties corresponding to the known key/value pairs allowed by OLE DB connections, and developers can add arbitrary key/value pairs for any other connection string values. Die OleDbConnectionStringBuilder-Klasse implementiert die ICustomTypeDescriptor-Schnittstelle.The OleDbConnectionStringBuilder class implements the ICustomTypeDescriptor interface. Dies bedeutet, dass die-Klasse zur Entwurfszeit mit Visual Studio .net-Designern arbeitet.This means that the class works with Visual Studio .NET designers at design time. Wenn Entwickler mit dem Designer stark typisierte Datasets und stark typisierte Verbindungen innerhalb von Visual Studio .NET erstellen, zeigt die stark typisierte Verbindungs Zeichenfolgen-Generator Klasse die Eigenschaften an, die dem Typ zugeordnet sind, und weist außerdem Konverter auf, die kann allgemeine Werte für bekannte Schlüssel zuordnen.When developers use the designer to build strongly typed DataSets and strongly typed connections within Visual Studio .NET, the strongly typed connection string builder class will display the properties associated with its type and will also have converters that can map common values for known keys.

Entwickler, die Verbindungszeichenfolgen als Teil von Anwendungen erstellen müssen, können die OleDbConnectionStringBuilder-Klasse verwenden, um Verbindungszeichenfolgen zu erstellen und zu ändern.Developers needing to create connection strings as part of applications can use the OleDbConnectionStringBuilder class to build and modify connection strings. Die Klasse vereinfacht auch die Verwaltung von Verbindungszeichenfolgen, die in einer Anwendungskonfigurationsdatei gespeichert sind.The class also makes it easy to manage connection strings stored in an application configuration file. Der OleDbConnectionStringBuilder überprüft nur die begrenzte Anzahl von bekannten Schlüssel-Wert-Paaren.The OleDbConnectionStringBuilder performs checks only for the limited set of known key/value pairs. Daher kann diese Klasse verwendet werden, um ungültige Verbindungs Zeichenfolgen zu erstellen.Therefore, this class can be used to create invalid connection strings. In der folgenden Tabelle werden die bekannten Schlüssel und die zugehörigen Eigenschaften innerhalb OleDbConnectionStringBuilder der-Klasse und ihre Standardwerte aufgeführt.The following table lists the known keys and their corresponding properties within the OleDbConnectionStringBuilder class, and their default values. Neben diesen speziellen Werten können Entwickler beliebige Schlüssel-Wert-Paare zur Auflistung hinzufügen, die in der OleDbConnectionStringBuilder -Instanz enthalten ist:Besides these specific values, developers can add any key/value pairs to the collection that is contained within the OleDbConnectionStringBuilder instance:

KeyKey EigenschaftProperty StandardwertDefault value
DateinameFile Name FileName """"
AnbieterProvider Provider """"
DatenquelleData Source DataSource """"
Persist Security InfoPersist Security Info PersistSecurityInfo FalseFalse
OLE DB DiensteOLE DB Services OleDbServices -13-13

Die Item[String] -Eigenschaft verarbeitet Versuche, schädliche Einträge einzufügen.The Item[String] property handles attempts to insert malicious entries. Beispielsweise wird mit dem folgenden Code, der die Item[String] Standard Eigenschaft (Indexer, in C#) verwendet, das Schlüssel-Wert-Paar mit dem Wert für das Schlüssel-Wert-Paar ordnungsgemäßFor example, the following code, using the default Item[String] property (the indexer, in C#) correctly escapes the nested key/value pair:

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

Das Ergebnis ist die folgende Verbindungszeichenfolge, die den ungültigen Wert sicher behandelt:The result is the following connection string that handles the invalid value in a safe manner:

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

Konstruktoren

OleDbConnectionStringBuilder()

Initialisiert eine neue Instanz der OleDbConnectionStringBuilder-Klasse.Initializes a new instance of the OleDbConnectionStringBuilder class.

OleDbConnectionStringBuilder(String)

Initialisiert eine neue Instanz der OleDbConnectionStringBuilder-Klasse.Initializes a new instance of the OleDbConnectionStringBuilder class. Die bereitgestellte Verbindungszeichenfolge stellt die Daten für die internen Verbindungsinformationen der Instanz bereit.The provided connection string provides the data for the instance's internal connection information.

Eigenschaften

BrowsableConnectionString

Ruft einen Wert ab, der angibt, ob die ConnectionString-Eigenschaft in Visual Studio-Designern sichtbar ist, oder legt diesen fest.Gets or sets a value that indicates whether the ConnectionString property is visible in Visual Studio designers.

(Geerbt von DbConnectionStringBuilder)
ConnectionString

Ruft die Verbindungszeichenfolge ab, die dem DbConnectionStringBuilder zugeordnet ist, oder legt diese fest.Gets or sets the connection string associated with the DbConnectionStringBuilder.

(Geerbt von DbConnectionStringBuilder)
Count

Ruft die aktuelle Anzahl von Schlüsseln ab, die innerhalb der ConnectionString-Eigenschaft enthalten sind.Gets the current number of keys that are contained within the ConnectionString property.

(Geerbt von DbConnectionStringBuilder)
DataSource

Ruft den Namen der Datenquelle ab, mit der eine Verbindung hergestellt werden soll, oder legt diesen fest.Gets or sets the name of the data source to connect to.

FileName

Ruft den Namen der Universal Data Link-Datei (UDL) zum Herstellen einer Verbindung mit der Datenquelle ab oder legt diesen fest.Gets or sets the name of the Universal Data Link (UDL) file for connecting to the data source.

IsFixedSize

Ruft einen Wert ab, der angibt, ob die DbConnectionStringBuilder eine feste Größe hat.Gets a value that indicates whether the DbConnectionStringBuilder has a fixed size.

(Geerbt von DbConnectionStringBuilder)
IsReadOnly

Ruft einen Wert ab, der angibt, ob die DbConnectionStringBuilder schreibgeschützt ist.Gets a value that indicates whether the DbConnectionStringBuilder is read-only.

(Geerbt von DbConnectionStringBuilder)
Item[String]

Ruft den Wert ab, der dem angegebenen Schlüssel zugeordnet ist, oder legt diesen fest.Gets or sets the value associated with the specified key. In C# ist diese Eigenschaft der Indexer.In C#, this property is the indexer.

Keys

Ruft eine ICollection ab, die die Schlüssel im OleDbConnectionStringBuilder enthält.Gets an ICollection that contains the keys in the OleDbConnectionStringBuilder.

OleDbServices

Ruft den Wert ab, der für den OLE DB Services-Schlüssel innerhalb der Verbindungszeichenfolge übergeben werden soll, oder legt diesen fest.Gets or sets the value to be passed for the OLE DB Services key within the connection string.

PersistSecurityInfo

Ruft einen booleschen Wert ab, der angibt, ob sicherheitsrelevante Informationen, z. B. das Kennwort, als Teil der Verbindung zurückgegeben werden, wenn die Verbindung geöffnet ist oder sich jemals im geöffneten Zustand befunden hat, oder legt diesen fest.Gets or sets a Boolean value that indicates whether security-sensitive information, such as the password, is returned as part of the connection if the connection is open or has ever been in an open state.

Provider

Ruft eine Zeichenfolge ab, die den Namen des der internen Verbindungszeichenfolge zugeordneten Datenanbieters enthält, oder legt diese fest.Gets or sets a string that contains the name of the data provider associated with the internal connection string.

Values

Ruft ein ICollection ab, das die Werte im DbConnectionStringBuilder enthält.Gets an ICollection that contains the values in the DbConnectionStringBuilder.

(Geerbt von DbConnectionStringBuilder)

Methoden

Add(String, Object)

Fügt dem DbConnectionStringBuilder einen Eintrag mit dem angegebenen Schlüssel und Wert hinzu.Adds an entry with the specified key and value into the DbConnectionStringBuilder.

(Geerbt von DbConnectionStringBuilder)
Clear()

Löscht den Inhalt der OleDbConnectionStringBuilder-Instanz.Clears the contents of the OleDbConnectionStringBuilder instance.

ClearPropertyDescriptors()

Löscht die Auflistung von PropertyDescriptor-Objekten, die dem DbConnectionStringBuilder zugeordnet sind.Clears the collection of PropertyDescriptor objects on the associated DbConnectionStringBuilder.

(Geerbt von DbConnectionStringBuilder)
ContainsKey(String)

Stellt fest, ob der OleDbConnectionStringBuilder einen bestimmten Schlüssel enthält.Determines whether the OleDbConnectionStringBuilder contains a specific key.

Equals(Object)

Bestimmt, ob das angegebene Objekt mit dem aktuellen Objekt identisch ist.Determines whether the specified object is equal to the current object.

(Geerbt von Object)
EquivalentTo(DbConnectionStringBuilder)

Vergleicht die Verbindungsinformationen in diesem DbConnectionStringBuilder-Objekt mit den Verbindungsinformationen im angegebenen Objekt.Compares the connection information in this DbConnectionStringBuilder object with the connection information in the supplied object.

(Geerbt von DbConnectionStringBuilder)
GetHashCode()

Fungiert als Standardhashfunktion.Serves as the default hash function.

(Geerbt von Object)
GetProperties(Hashtable)

Füllt eine angegebene Hashtable mit Informationen zu allen Eigenschaften dieses DbConnectionStringBuilder.Fills a supplied Hashtable with information about all the properties of this DbConnectionStringBuilder.

(Geerbt von DbConnectionStringBuilder)
GetType()

Ruft den Type der aktuellen Instanz ab.Gets the Type of the current instance.

(Geerbt von Object)
MemberwiseClone()

Erstellt eine flache Kopie des aktuellen Object.Creates a shallow copy of the current Object.

(Geerbt von Object)
Remove(String)

Entfernt den Eintrag mit dem angegebenen Schlüssel aus der OleDbConnectionStringBuilder-Instanz.Removes the entry with the specified key from the OleDbConnectionStringBuilder instance.

ShouldSerialize(String)

Gibt an, ob der angegebene Schlüssel in dieser DbConnectionStringBuilder-Instanz vorhanden ist.Indicates whether the specified key exists in this DbConnectionStringBuilder instance.

(Geerbt von DbConnectionStringBuilder)
ToString()

Gibt die diesem DbConnectionStringBuilder zugeordnete Verbindungszeichenfolge zurück.Returns the connection string associated with this DbConnectionStringBuilder.

(Geerbt von DbConnectionStringBuilder)
TryGetValue(String, Object)

Ruft einen Wert ab, der dem von dieser OleDbConnectionStringBuilder-Instanz bereitgestellten Schlüssel entspricht.Retrieves a value corresponding to the supplied key from the OleDbConnectionStringBuilder instance.

Explizite Schnittstellenimplementierungen

ICollection.CopyTo(Array, Int32)

Kopiert die Elemente der ICollection in ein Array, beginnend bei einem bestimmten Array-Index.Copies the elements of the ICollection to an Array, starting at a particular Array index.

(Geerbt von DbConnectionStringBuilder)
ICollection.IsSynchronized

Ruft einen Wert ab, der angibt, ob der Zugriff auf die ICollection synchronisiert (threadsicher) ist.Gets a value indicating whether access to the ICollection is synchronized (thread safe).

(Geerbt von DbConnectionStringBuilder)
ICollection.SyncRoot

Ruft ein Objekt ab, mit dem der Zugriff auf ICollection synchronisiert werden kann.Gets an object that can be used to synchronize access to the ICollection.

(Geerbt von DbConnectionStringBuilder)
ICustomTypeDescriptor.GetAttributes()

Gibt eine Auflistung benutzerdefinierter Attribute für diese Instanz einer Komponente zurück.Returns a collection of custom attributes for this instance of a component.

(Geerbt von DbConnectionStringBuilder)
ICustomTypeDescriptor.GetClassName()

Gibt den Klassennamen dieser Instanz einer Komponente zurück.Returns the class name of this instance of a component.

(Geerbt von DbConnectionStringBuilder)
ICustomTypeDescriptor.GetComponentName()

Gibt den Namen dieser Instanz einer Komponente zurück.Returns the name of this instance of a component.

(Geerbt von DbConnectionStringBuilder)
ICustomTypeDescriptor.GetConverter()

Gibt einen Typkonverter für diese Instanz einer Komponente zurück.Returns a type converter for this instance of a component.

(Geerbt von DbConnectionStringBuilder)
ICustomTypeDescriptor.GetDefaultEvent()

Gibt das Standardereignis für diese Instanz einer Komponente zurück.Returns the default event for this instance of a component.

(Geerbt von DbConnectionStringBuilder)
ICustomTypeDescriptor.GetDefaultProperty()

Gibt die Standardeigenschaft für diese Instanz einer Komponente zurück.Returns the default property for this instance of a component.

(Geerbt von DbConnectionStringBuilder)
ICustomTypeDescriptor.GetEditor(Type)

Gibt einen Editor des angegebenen Typs für diese Instanz einer Komponente zurück.Returns an editor of the specified type for this instance of a component.

(Geerbt von DbConnectionStringBuilder)
ICustomTypeDescriptor.GetEvents()

Gibt die Ereignisse für diese Instanz einer Komponente zurück.Returns the events for this instance of a component.

(Geerbt von DbConnectionStringBuilder)
ICustomTypeDescriptor.GetEvents(Attribute[])

Gibt die Ereignisse für diese Instanz einer Komponente zurück, wobei das angegebene Attributarray als Filter verwendet wird.Returns the events for this instance of a component using the specified attribute array as a filter.

(Geerbt von DbConnectionStringBuilder)
ICustomTypeDescriptor.GetProperties()

Gibt die Eigenschaften für diese Instanz einer Komponente zurück.Returns the properties for this instance of a component.

(Geerbt von DbConnectionStringBuilder)
ICustomTypeDescriptor.GetProperties(Attribute[])

Gibt die Eigenschaften für diese Instanz einer Komponente zurück, wobei das Attributarray als Filter verwendet wird.Returns the properties for this instance of a component using the attribute array as a filter.

(Geerbt von DbConnectionStringBuilder)
ICustomTypeDescriptor.GetPropertyOwner(PropertyDescriptor)

Gibt ein Objekt zurück, das die Eigenschaft enthält, die durch den Eigenschaftendeskriptor angegeben ist.Returns an object that contains the property described by the specified property descriptor.

(Geerbt von DbConnectionStringBuilder)
IDictionary.Add(Object, Object)

Fügt dem IDictionary-Objekt ein Element mit dem angegebenen Schlüssel und Wert hinzu.Adds an element with the provided key and value to the IDictionary object.

(Geerbt von DbConnectionStringBuilder)
IDictionary.Contains(Object)

Ermittelt, ob das IDictionary-Objekt ein Element mit dem angegebenen Schlüssel enthält.Determines whether the IDictionary object contains an element with the specified key.

(Geerbt von DbConnectionStringBuilder)
IDictionary.GetEnumerator()

Gibt ein IDictionaryEnumerator-Objekt für das IDictionary-Objekt zurück.Returns an IDictionaryEnumerator object for the IDictionary object.

(Geerbt von DbConnectionStringBuilder)
IDictionary.IsFixedSize (Geerbt von DbConnectionStringBuilder)
IDictionary.IsReadOnly (Geerbt von DbConnectionStringBuilder)
IDictionary.Item[Object]

Ruft das Element mit dem angegebenen Schlüssel ab oder legt dieses fest.Gets or sets the element with the specified key.

(Geerbt von DbConnectionStringBuilder)
IDictionary.Remove(Object)

Entfernt das Element mit dem angegebenen Schlüssel aus dem IDictionary-Objekt.Removes the element with the specified key from the IDictionary object.

(Geerbt von DbConnectionStringBuilder)
IEnumerable.GetEnumerator()

Gibt einen Enumerator zurück, der eine Auflistung durchläuft.Returns an enumerator that iterates through a collection.

(Geerbt von DbConnectionStringBuilder)

Erweiterungsmethoden

Cast<TResult>(IEnumerable)

Wandelt die Elemente eines IEnumerable in den angegebenen Typ umCasts the elements of an IEnumerable to the specified type.

OfType<TResult>(IEnumerable)

Filtert die Elemente eines IEnumerable anhand eines angegebenen TypsFilters the elements of an IEnumerable based on a specified type.

AsParallel(IEnumerable)

Ermöglicht die Parallelisierung einer Abfrage.Enables parallelization of a query.

AsQueryable(IEnumerable)

Konvertiert einen IEnumerable in einen IQueryable.Converts an IEnumerable to an IQueryable.

Gilt für:

Siehe auch