Export (0) Print
Expand All

SqlConnectionStringBuilder.TryGetValue Method

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

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

abstract TryGetValue : 
        keyword:string * 
        value:Object byref -> bool  
override TryGetValue : 
        keyword:string * 
        value:Object byref -> bool

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.

ExceptionCondition
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

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Show:
© 2014 Microsoft