DbConnectionStringBuilder::Add Method (String^, Object^)

.NET Framework (current version)

Adds an entry with the specified key and value into the DbConnectionStringBuilder.

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

Syntax

public:
void Add(
	String^ keyword,
	Object^ value
)

Parameters

keyword: Type: System::String^
The key to add to the DbConnectionStringBuilder.

value: Type: System::Object^
The value for the specified key.

Exceptions

Exception	Condition
ArgumentNullException	keyword is a null reference (Nothing in Visual Basic).
NotSupportedException	The DbConnectionStringBuilder is read-only. -or- The DbConnectionStringBuilder has a fixed size.

Remarks

The Item property can also be used to add new elements by setting the value of a key that does not exist in the dictionary. For example: myCollection["myNonexistentKey"] = myValue.

Calling the Add method by passing a null (Nothing in Visual Basic) key throws an ArgumentNullException. However, calling the Add method by passing a null value removes the key/value pair.

The following example creates a new DbConnectionStringBuilder and adds items. The code also demonstrates overwriting an existing item using the Add method, and includes a commented block that would throw an ArgumentNullException.

Note
This example includes a password to demonstrate how DbConnectionStringBuilder 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.

C++

No code example is currently available or this language may not be supported.

Version Information

Universal Windows Platform
Available since 10
.NET Framework
Available since 2.0