DbConnectionStringBuilder::TryGetValue Method (String^, Object^%)

.NET Framework (current version)

Retrieves a value corresponding to the supplied key from this DbConnectionStringBuilder.

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

Syntax

public:
virtual bool TryGetValue(
	String^ keyword,
	[OutAttribute] Object^% value
)

Parameters

keyword: Type: System::String^
The key of the item to retrieve.

value: Type: System::Object^%
The value corresponding to the key.

Return Value

Type: System::Boolean

true if keyword was found within the connection string, false otherwise.

Exceptions

Exception	Condition
ArgumentNullException	keyword contains a null value (Nothing in Visual Basic).

The TryGetValue method lets developers safely retrieve a value from a DbConnectionStringBuilder without needing to first call the ContainsKey method. Because TryGetValue does not raise an exception when you call it, passing in a nonexistent key, you do not have to look for a key before retrieving its value. Calling TryGetValue with a nonexistent key will place the null value (Nothing in Visual Basic) in the value parameter.

Examples

The following example calls the TryGetValue method, demonstrating several possible outcomes.

C++

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

The sample displays the following results:

Provider=sqloledb
DATA SOURCE=192.168.168.1,1433
Unable to retrieve value for //InvalidKey//
Unable to retrieve value for null key.

Version Information

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