Enumerable.ToLookup(Of TSource, TKey, TElement) Method (IEnumerable(Of TSource), Func(Of TSource, TKey), Func(Of TSource, TElement), IEqualityComparer(Of TKey))
Creates a Lookup(Of TKey, TElement) from an IEnumerable(Of T) according to a specified key selector function, a comparer and an element selector function.
Assembly: System.Core (in System.Core.dll)
'Declaration <ExtensionAttribute> _ Public Shared Function ToLookup(Of TSource, TKey, TElement) ( _ source As IEnumerable(Of TSource), _ keySelector As Func(Of TSource, TKey), _ elementSelector As Func(Of TSource, TElement), _ comparer As IEqualityComparer(Of TKey) _ ) As ILookup(Of TKey, TElement) 'Usage Dim source As IEnumerable(Of TSource) Dim keySelector As Func(Of TSource, TKey) Dim elementSelector As Func(Of TSource, TElement) Dim comparer As IEqualityComparer(Of TKey) Dim returnValue As ILookup(Of TKey, TElement) returnValue = source.ToLookup(keySelector, _ elementSelector, comparer)
Type Parameters
- TSource
The type of the elements of source.
- TKey
The type of the key returned by keySelector.
- TElement
The type of the value returned by elementSelector.
Parameters
- source
- Type: System.Collections.Generic.IEnumerable(Of TSource)
The IEnumerable(Of T) to create a Lookup(Of TKey, TElement) from.
- keySelector
- Type: System.Func(Of TSource, TKey)
A function to extract a key from each element.
- elementSelector
- Type: System.Func(Of TSource, TElement)
A transform function to produce a result element value from each element.
- comparer
- Type: System.Collections.Generic.IEqualityComparer(Of TKey)
An IEqualityComparer(Of T) to compare keys.
Return Value
Type: System.Linq.ILookup(Of TKey, TElement)A Lookup(Of TKey, TElement) that contains values of type TElement selected from the input sequence.
Usage Note
In Visual Basic and C#, you can call this method as an instance method on any object of type IEnumerable(Of TSource). When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).| Exception | Condition |
|---|---|
| ArgumentNullException | source or keySelector or elementSelector is Nothing. |
The ToLookup(Of TSource, TKey, TElement)(IEnumerable(Of TSource), Func(Of TSource, TKey), Func(Of TSource, TElement), IEqualityComparer(Of TKey)) method returns a Lookup(Of TKey, TElement), a one-to-many dictionary that maps keys to collections of values. A Lookup(Of TKey, TElement) differs from a Dictionary(Of TKey, TValue), which performs a one-to-one mapping of keys to single values.
If comparer is Nothing, the default equality comparer Default is used to compare keys.
Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune
The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.