OleDbConnectionStringBuilder.Keys Property
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.
Gets an ICollection that contains the keys in the OleDbConnectionStringBuilder.
public:
virtual property System::Collections::ICollection ^ Keys { System::Collections::ICollection ^ get(); };public override System.Collections.ICollection Keys { get; }member this.Keys : System.Collections.ICollectionPublic Overrides ReadOnly Property Keys As ICollectionProperty Value
An ICollection that contains the keys in the OleDbConnectionStringBuilder.
Examples
The following console application example creates a new OleDbConnectionStringBuilder. The code loops through the ICollection returned by the Keys property displaying the key/value pairs.
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 a 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
The order of the values in the ICollection is unspecified, but it is the same order as the associated values in the ICollection returned by the Values property.
