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

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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

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

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

Parameters

keyword
Type: System::String^

The key of the item to retrieve.

value
Type: System::Object^%

The value corresponding to keyword.

Return Value

Type: System::Boolean

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

Exception Condition
ArgumentNullException

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

The TryGetValue method lets developers safely retrieve a value from a SqlConnectionStringBuilder without needing to verify that the supplied key name is a valid key name. 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 value null (Nothing in Visual Basic) in the value parameter.

The following example demonstrates the behavior of the TryGetValue method.

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

The sample displays the following results:

Data Source=(local)
Trusted_Connection=True
Unable to retrieve value for 'InvalidKey'
Unable to retrieve value for null key.

.NET Framework
Available since 2.0
Return to top
Show: