Windows Dev Center

Enumerable::Union<TSource> Method (IEnumerable<TSource>, IEnumerable<TSource>, IEqualityComparer<TSource>)

Produces the set union of two sequences by using a specified IEqualityComparer<T>.

Namespace:  System.Linq
Assemblies:   System.Linq (in System.Linq.dll)
  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).

ExceptionCondition
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.

The following example shows how to implement an equality comparer that can be used in the Union method.

No code example is currently available or this language may not be supported.

After you implement this comparer, you can use sequences of Product objects in the Union method, as shown in the following example.

No code example is currently available or this language may not be supported.

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

XNA Framework

Supported in: 3.0

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone Silverlight 8.1, Windows Phone Silverlight 8

Portable Class Library

Supported in: Portable Class Library
Show:
© 2015 Microsoft