IReadOnlyDictionary<'TKey, 'TValue>.TryGetValue Method ('TKey, 'TValue)

.NET Framework (current version)
 

Gets the value that is associated with the specified key.

Namespace:   System.Collections.Generic
Assembly:  mscorlib (in mscorlib.dll)

abstract TryGetValue : 
        key:'TKey *
        value:'TValue byref -> bool

Parameters

key
Type: TKey

The key to locate.

value
Type: 'TValue

When this method returns, the value associated with the specified key, if the key is found; otherwise, the default value for the type of the value parameter. This parameter is passed uninitialized.

Return Value

Type: System.Boolean

true if the object that implements the IReadOnlyDictionary<'TKey, 'TValue> interface contains an element that has the specified key; otherwise, false.

Exception Condition
ArgumentNullException

key is null.

This method combines the functionality of the ContainsKey method and the Item property.

If the key is not found, the value parameter gets the appropriate default value for the type TValue: for example, 0 (zero) for integer types, false for Boolean types, and null for reference types.

Universal Windows Platform
Available since 8
.NET Framework
Available since 4.5
Portable Class Library
Supported in: portable .NET platforms
Windows Phone Silverlight
Available since 8.0
Windows Phone
Available since 8.1
Return to top
Show: