Enumerable::Union<TSource> Method (IEnumerable<TSource>, IEnumerable<TSource>, IEqualityComparer<TSource>)
Updated: October 2008
Produces the set union of two sequences by using a specified IEqualityComparer<T>.
Assembly: System.Core (in System.Core.dll)
[ExtensionAttribute] public: generic<typename TSource> static IEnumerable<TSource>^ Union( IEnumerable<TSource>^ first, IEnumerable<TSource>^ second, IEqualityComparer<TSource>^ comparer )
Type Parameters
- TSource
The type of the elements of the input sequences.
Parameters
- first
- Type: System.Collections.Generic::IEnumerable<TSource>
An IEnumerable<T> whose distinct elements form the first set for the union.
- second
- Type: System.Collections.Generic::IEnumerable<TSource>
An IEnumerable<T> whose distinct elements form the second set for the union.
- comparer
- Type: System.Collections.Generic::IEqualityComparer<TSource>
The IEqualityComparer<T> to compare values.
Return Value
Type: System.Collections.Generic::IEnumerable<TSource>An IEnumerable<T> that contains the elements from both input sequences, excluding duplicates.
Usage Note
In Visual Basic and C#, you can call this method as an instance method on any object of type IEnumerable<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 | first or second is nullptr. |
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 nullptr, the default equality comparer, Default, is used to compare values.
When the object returned by this method is enumerated, Union enumerates first and second in that order and yields each element that has not already been yielded.
The Concat<TSource> method differs from the Union method because the Concat<TSource> method returns all the elements in the input sequences including duplicates, whereas Union returns only unique values.
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.