IDictionary(TKey, TValue).TryGetValue Method
Gets the value associated with the specified key.
Namespace: System.Collections.Generic
Assembly: mscorlib (in mscorlib.dll)
Parameters
- key
- Type: TKey
The key whose value to get.
- 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.Booleantrue if the object that implements IDictionary(TKey, TValue) contains an element with the specified key; otherwise, false.
| Exception | Condition |
|---|---|
| ArgumentNullException | key is a null reference (Nothing in Visual Basic). |
This method combines the functionality of the ContainsKey method and the Item property.
If the key is not found, then the value parameter gets the appropriate default value for the value type V; for example, zero (0) for integer types, false for Boolean types, and a null reference (Nothing in Visual Basic) for reference types.
The example shows how to use the TryGetValue method to retrieve values. If a program frequently tries key values that are not in a dictionary, the TryGetValue method can be more efficient than using the Item property (the indexer in C#), which throws exceptions when attempting to retrieve nonexistent keys.
This code is part of a larger example that can be compiled and executed. See System.Collections.Generic.IDictionary(TKey, TValue).
For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.