OleDbConnectionStringBuilder Constructors
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Initializes a new instance of the OleDbConnectionStringBuilder class.
Overloads
| OleDbConnectionStringBuilder() |
Initializes a new instance of the OleDbConnectionStringBuilder class. |
| OleDbConnectionStringBuilder(String) |
Initializes a new instance of the OleDbConnectionStringBuilder class. The provided connection string provides the data for the instance's internal connection information. |
OleDbConnectionStringBuilder()
Initializes a new instance of the OleDbConnectionStringBuilder class.
public:
OleDbConnectionStringBuilder();public OleDbConnectionStringBuilder ();Public Sub New ()See also
Applies to
OleDbConnectionStringBuilder(String)
Initializes a new instance of the OleDbConnectionStringBuilder class. The provided connection string provides the data for the instance's internal connection information.
public:
OleDbConnectionStringBuilder(System::String ^ connectionString);public OleDbConnectionStringBuilder (string? connectionString);public OleDbConnectionStringBuilder (string connectionString);new System.Data.OleDb.OleDbConnectionStringBuilder : string -> System.Data.OleDb.OleDbConnectionStringBuilderPublic Sub New (connectionString As String)Parameters
- connectionString
- String
The basis for the object's internal connection information. Parsed into key/value pairs.
Exceptions
The connection string is incorrectly formatted (perhaps missing the required "=" within a key/value pair).
Examples
The following example creates multiple OleDbConnectionStringBuilder instances, passing a different connection string to the constructor in each case. Note how setting the provider associated with the connection changes the set of predefined key/value pairs within the object's collection.
Note
This example includes a password to demonstrate how OleDbConnectionStringBuilder works with connection strings. In your applications, we recommend that you use Windows Authentication. 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()
{
try
{
// Build an empty instance, just to see
// the contents of the keys.
DumpBuilderContents("");
// Create a SQL Server connection string.
DumpBuilderContents("Provider=sqloledb;Data Source=(local);" +
"Initial Catalog=AdventureWorks;" +
"User Id=ab;Password=Password@1");
// Create an Access connection string.
DumpBuilderContents("Provider=Microsoft.Jet.OLEDB.4.0;" +
@"Data Source=C:\Sample.mdb");
// Create an Oracle connection string.
DumpBuilderContents("Provider=msdaora;Data Source=SomeOracleDb;" +
"User Id=userName;Password=Pass@word1;");
// Create an Sybase connection string.
DumpBuilderContents("Provider=ASAProv;Data source=myASA");
Console.WriteLine("Press any key to finish.");
Console.ReadLine();
}
catch (System.ArgumentException ex)
{
Console.WriteLine("Error: " + ex.Message);
}
}
private static void DumpBuilderContents(string connectString)
{
OleDbConnectionStringBuilder builder =
new OleDbConnectionStringBuilder(connectString);
Console.WriteLine("=================");
Console.WriteLine("Original connectString = " + connectString);
Console.WriteLine("builder.ConnectionString = " + builder.ConnectionString);
foreach (string key in builder.Keys)
{
Console.WriteLine(key + "=" + builder[key].ToString());
}
}
}
Imports System.Data.OleDb
Module Module1
Sub Main()
Try
' Build an empty instance, just to see
' the contents of the keys.
DumpBuilderContents("")
' Create a SQL Server connection string.
DumpBuilderContents("Provider=sqloledb;Data Source=(local);" & _
"Initial Catalog=AdventureWorks;" & _
"User Id=ab;Password=Password@1")
' Create an Access connection string.
DumpBuilderContents("Provider=Microsoft.Jet.OLEDB.4.0;" & _
"Data Source=C:\Sample.mdb")
' Create an Oracle connection string.
DumpBuilderContents("Provider=msdaora;Data Source=SomeOracleDb;" & _
"User Id=userName;Password=Pass@word1;")
' Create a Sybase connection string.
DumpBuilderContents("Provider=ASAProv;Data source=myASA")
Console.WriteLine("Press any key to finish.")
Console.ReadLine()
Catch ex As System.ArgumentException
Console.WriteLine("Error: " & ex.Message)
End Try
End Sub
Private Sub DumpBuilderContents(ByVal connectString As String)
Dim builder As New OleDbConnectionStringBuilder(connectString)
Console.WriteLine("=================")
Console.WriteLine("Original connectString = " & connectString)
Console.WriteLine("builder.ConnectionString = " & builder.ConnectionString)
For Each key As String In builder.Keys
Console.WriteLine(key & "=" & builder.Item(key).ToString)
Next
End Sub
End Module
Remarks
Setting the Provider property, either directly (by setting the ConnectionString property) or by passing a connection string as a parameter to the constructor, may affect the set of key/value pairs that are contained within the OleDbConnectionStringBuilder instance. Setting the Provider property to "sqloledb," for example, adds all the standard SQL connection string properties. See the example in this topic for a demonstration of this behavior.
For some providers, assigning a connection string within the OleDbConnectionStringBuilder constructor causes the order of supplied key/value pairs to be rearranged.
