Enumerable.GroupJoin<(Of <(TOuter, TInner, TKey, TResult>)>) Method (IEnumerable<(Of <(TOuter>)>), IEnumerable<(Of <(TInner>)>), Func<(Of <(TOuter, TKey>)>), Func<(Of <(TInner, TKey>)>), Func<(Of <(TOuter, IEnumerable<(Of <(TInner>)>), TResult>)>), IEqualityComparer<(Of <(TKey>)>))

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

Correlates the elements of two sequences based on key equality and groups the results. A specified IEqualityComparer<(Of <(T>)>) is used to compare keys.

Namespace: System.Linq
Assembly: System.Core (in System.Core.dll)

Syntax

<ExtensionAttribute> _
Public Shared Function GroupJoin(Of TOuter, TInner, TKey, TResult) ( _
    outer As IEnumerable(Of TOuter), _
    inner As IEnumerable(Of TInner), _
    outerKeySelector As Func(Of TOuter, TKey), _
    innerKeySelector As Func(Of TInner, TKey), _
    resultSelector As Func(Of TOuter, IEnumerable(Of TInner), TResult), _
    comparer As IEqualityComparer(Of TKey) _
) As IEnumerable(Of TResult)
public static IEnumerable<TResult> GroupJoin<TOuter, TInner, TKey, TResult>(
    this IEnumerable<TOuter> outer,
    IEnumerable<TInner> inner,
    Func<TOuter, TKey> outerKeySelector,
    Func<TInner, TKey> innerKeySelector,
    Func<TOuter, IEnumerable<TInner>, TResult> resultSelector,
    IEqualityComparer<TKey> comparer
)

Type Parameters

  • TOuter
    The type of the elements of the first sequence.
  • TInner
    The type of the elements of the second sequence.
  • TKey
    The type of the keys returned by the key selector functions.
  • TResult
    The type of the result elements.

Parameters

  • outerKeySelector
    Type: System..::.Func<(Of <(TOuter, TKey>)>)
    A function to extract the join key from each element of the first sequence.
  • innerKeySelector
    Type: System..::.Func<(Of <(TInner, TKey>)>)
    A function to extract the join key from each element of the second sequence.
  • resultSelector
    Type: System..::.Func<(Of <(TOuter, IEnumerable<(Of <(TInner>)>), TResult>)>)
    A function to create a result element from an element from the first sequence and a collection of matching elements from the second sequence.

Return Value

Type: System.Collections.Generic..::.IEnumerable<(Of <(TResult>)>)
An IEnumerable<(Of <(T>)>) that contains elements of type TResult that are obtained by performing a grouped join on two sequences.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IEnumerable<(Of <(TOuter>)>). When you use instance method syntax to call this method, omit the first parameter.

Exceptions

Exception Condition
ArgumentNullException

outer or inner or outerKeySelector or innerKeySelector or resultSelector is nullNothingnullptra null reference (Nothing in Visual Basic).

Remarks

This method is implemented by using deferred execution. The immediate return value is an object that stores all the information that is required to perform the action. The query represented by this method is not executed until the object is enumerated either by calling its GetEnumerator method directly or by using foreach in Visual C# or For Each in Visual Basic.

If comparer is nullNothingnullptra null reference (Nothing in Visual Basic), the default equality comparer, Default, is used to hash and compare keys.

GroupJoin produces hierarchical results, which means that elements from outer are paired with collections of matching elements from inner. GroupJoin enables you to base your results on a whole set of matches for each element of outer.

Note

If there are no correlated elements in inner for a given element of outer, the sequence of matches for that element will be empty but will still appear in the results.

The resultSelector function is called only one time for each outer element together with a collection of all the inner elements that match the outer element. This differs from the Join method in which the result selector function is invoked on pairs that contain one element from outer and one element from inner.

GroupJoin preserves the order of the elements of outer, and for each element of outer, the order of the matching elements from inner.

GroupJoin has no direct equivalent in traditional relational database terms. However, this method does implement a superset of inner joins and left outer joins. Both of these operations can be written in terms of a grouped join.

Version Information

Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Platforms

Windows Phone

See Also

Reference

Enumerable Class

GroupJoin Overload

System.Linq Namespace