ImmutableDictionary<TKey,TValue>.Builder.TryGetKey(TKey, TKey) Method

Definition

Namespace:

System.Collections.Immutable

Assembly:

System.Collections.Immutable.dll

Package:

System.Collections.Immutable v9.0.0-rc.2.24473.5

Source:

ImmutableDictionary_2.Builder.cs

Determines whether this dictionary contains a specified key.

public:
 bool TryGetKey(TKey equalKey, [Runtime::InteropServices::Out] TKey % actualKey);

public bool TryGetKey (TKey equalKey, out TKey actualKey);

member this.TryGetKey : 'Key * 'Key -> bool

Public Function TryGetKey (equalKey As TKey, ByRef actualKey As TKey) As Boolean

Parameters

equalKey

TKey

The key to search for.

actualKey

TKey

The matching key located in the dictionary if found, or equalkey if no match is found.

Returns

Boolean

true if a match for equalKey is found; otherwise, false.

Remarks

Following are some scenarios where TryGetKey may be useful:

• You want to reuse a previously stored object reference instead of creating a new reference.

• You want to look up the canonical value of an object

• You want to retrieve more complete data about an object