OdbcConnectionStringBuilder.Item[String] Property

Definition

Namespace:

System.Data.Odbc

Assembly:

System.Data.Odbc.dll

Package:

System.Data.Odbc v9.0.0-preview.3.24172.9

Source:

OdbcConnectionStringbuilder.cs

Gets or sets the value associated with the specified key. In C#, this property is the indexer.

public:
 virtual property System::Object ^ default[System::String ^] { System::Object ^ get(System::String ^ keyword); void set(System::String ^ keyword, System::Object ^ value); };

public override object this[string keyword] { get; set; }

member this.Item(string) : obj with get, set

Default Public Overrides Property Item(keyword As String) As Object

Parameters

keyword

String

The key of the item to get or set.

Property Value

Object

The value associated with the specified key.

Exceptions

ArgumentException

The connection string is incorrectly formatted (perhaps missing the required "=" within a key/value pair).

ArgumentNullException

keyword is a null reference (Nothing in Visual Basic).

Examples

The following code, in a console application, creates a new OdbcConnectionStringBuilder and adds key/value pairs to its connection string, using the Item[] property.

using System.Data.Odbc;

class Program
{
    static void Main()
    {
        OdbcConnectionStringBuilder builder =
            new OdbcConnectionStringBuilder();
        // Set up a connection string for a text file.
        builder["Driver"] = "Microsoft Text Driver (*.txt; *.csv)";
        builder["dbq"] = "C:\\TextFilesFolder";
        builder["Extension"] = "asc,csv,tab,txt";

        // Overwrite the existing value for the dbq value,
        // because it already exists within the collection.
        builder["dbq"] = "D:\\";

        Console.WriteLine(builder.ConnectionString);
        Console.WriteLine();
        Console.WriteLine("Press Enter to continue.");
        Console.ReadLine();
    }
}

Imports System.Data.Odbc    

Module Module1
  Sub Main()
    Dim builder As New OdbcConnectionStringBuilder
    ' Set up a connection string for a text file.
    builder.Item("Driver") = "Microsoft Text Driver (*.txt; *.csv)"
    ' Note that Item is the default property, so 
    ' you need not include it in the reference.
    builder("dbq") = "C:\TextFilesFolder"
    builder.Item("Extension") = "asc,csv,tab,txt"

    ' Overwrite the existing value for the dbq value, 
    ' because it already exists within the collection.
    builder.Item("dbq") = "D:\"

    Console.WriteLine(builder.ConnectionString)
    Console.WriteLine()
    Console.WriteLine("Press Enter to continue.")
    Console.ReadLine()
  End Sub
End Module

Remarks

When you set this property, if the specified key already exists in the dictionary, the value is replaced; otherwise, a new element is created.

See also

• Connection String Builders
• Connection Strings in ADO.NET