FrozenDictionary<TKey,TValue>.TryGetAlternateLookup<TAlternateKey> Method

Definition

Namespace:

System.Collections.Frozen

Assembly:

System.Collections.Immutable.dll

Gets an instance of a type that may be used to perform operations on a FrozenDictionary<TKey,TValue> using a TAlternateKey as a key instead of a TKey.

public:
generic <typename TAlternateKey>
 bool TryGetAlternateLookup([Runtime::InteropServices::Out] System::Collections::Frozen::FrozenDictionary<TKey, TValue>::AlternateLookup<TAlternateKey> % lookup);

public bool TryGetAlternateLookup<TAlternateKey> (out System.Collections.Frozen.FrozenDictionary<TKey,TValue>.AlternateLookup<TAlternateKey> lookup);

member this.TryGetAlternateLookup : AlternateLookup -> bool

Public Function TryGetAlternateLookup(Of TAlternateKey) (ByRef lookup As FrozenDictionary(Of TKey, TValue).AlternateLookup(Of TAlternateKey)) As Boolean

Type Parameters

TAlternateKey

The alternate type of a key for performing lookups.

Parameters

lookup

FrozenDictionary<TKey,TValue>.AlternateLookup<TAlternateKey>

The created lookup instance when the method returns true, or a default instance that should not be used if the method returns false.

Returns

Boolean

true if a lookup could be created; otherwise, false.

Remarks

This instance must be using a comparer that implements IAlternateEqualityComparer<TAlternate,T> with TAlternateKey and TKey. If it doesn't, the method will return false.