Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

SqlConnectionStringBuilder.Item Property

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

Namespace:  System.Data.SqlClient
Assembly:  System.Data (in System.Data.dll)

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

Parameters

keyword
Type: System.String
The key of the item to get or set.

Property Value

Type: System.Object
The value associated with the specified key.

ExceptionCondition
ArgumentNullException

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

KeyNotFoundException

Tried to add a key that does not exist within the available keys.

FormatException

Invalid value within the connection string (specifically, a Boolean or numeric value was expected but not supplied).

Because the SqlConnectionStringBuilder contains a fixed-size dictionary, trying to add a key that does not exist within the dictionary throws a KeyNotFoundException.

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


class Program
{
    static void Main()
    {
        SqlConnectionStringBuilder builder = 
            new SqlConnectionStringBuilder();
        builder["Data Source"] = "(local)";
        builder["Integrated Security"] = true;
        builder["Initial Catalog"] = "AdventureWorks";

        // Overwrite the existing value for the Data Source value.
        builder["Data Source"] = ".";

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


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Community Additions

ADD
Show:
© 2015 Microsoft