Windows apps
Collapse the table of content
Expand the table of content
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

SortedDictionary<TKey, TValue>::TryGetValue Method (TKey, TValue%)

 

Gets the value associated with the specified key.

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

public:
virtual bool TryGetValue(
	TKey key,
	[OutAttribute] TValue% value
) sealed

Parameters

key
Type: TKey

The key of the 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.

Return Value

Type: System::Boolean

true if the SortedDictionary<TKey, TValue> contains an element with 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, then the value parameter gets the appropriate default value for the value type TValue; for example, 0 (zero) for integer types, false for Boolean types, and null for reference types.

This method is an O(log n) operation.

The example shows how to use the TryGetValue method as a more efficient way to retrieve values in a program that frequently tries keys that are not in the dictionary. For contrast, the example also shows how the Item property (the indexer in C#) throws exceptions when attempting to retrieve nonexistent keys.

This code example is part of a larger example provided for the SortedDictionary<TKey, TValue> class.

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

Universal Windows Platform
Available since 8
.NET Framework
Available since 2.0
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:
© 2017 Microsoft