SqlConnectionStringBuilder.Item[String] 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 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, setDefault Public Overrides Property Item(keyword As String) As ObjectParameters
- keyword
- String
The key of the item to get or set.
Property Value
The value associated with the specified key.
Exceptions
keyword is a null reference (Nothing in Visual Basic).
Tried to add a key that does not exist within the available keys.
Invalid value within the connection string (specifically, a Boolean or numeric value was expected but not supplied).
Examples
The following code, in a console application, creates a new SqlConnectionStringBuilder and adds key/value pairs to its connection string, using the Item[] property.
using Microsoft.Data.SqlClient;
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();
}
}
Remarks
Because the SqlConnectionStringBuilder contains a fixed-size dictionary, trying to add a key that does not exist within the dictionary throws a KeyNotFoundException.