Duration (Pacific Standard Time):
To (Pacific Standard Time):
  • None
User Action:
  • None

Enumerable.Empty<TResult> Method ()


The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Returns an empty IEnumerable<T> that has the specified type argument.

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

Public Shared Function Empty(Of TResult) As IEnumerable(Of TResult)

Return Value

Type: System.Collections.Generic.IEnumerable<TResult>

An empty IEnumerable<T> whose type argument is TResult.

Type Parameters


The type to assign to the type parameter of the returned generic IEnumerable<T>.

The Empty<TResult>() method caches an empty sequence of type TResult. When the object it returns is enumerated, it yields no elements.

In some cases, this method is useful for passing an empty sequence to a user-defined method that takes an IEnumerable<T>. It can also be used to generate a neutral element for methods such as Union<TSource>. See the Example section for an example of this use of Empty<TResult>().

The following code example demonstrates how to use Empty<TResult>() to generate an empty IEnumerable<T>.

' Create an empty sequence.
Dim empty As IEnumerable(Of Decimal) = Enumerable.Empty(Of Decimal)()

The following code example demonstrates a possible application of the Empty<TResult>() method. The Aggregate<TSource> method is applied to a collection of string arrays. The elements of each array in the collection are added to the resulting IEnumerable<T> only if that array contains four or more elements. Empty<TResult> is used to generate the seed value for Aggregate<TSource> because if no array in the collection has four or more elements, only the empty sequence is returned.

' Create three string arrays.
Dim names1() As String =
{"Hartono, Tommy"}
Dim names2() As String =
{"Adams, Terry", "Andersen, Henriette Thaulow", "Hedlund, Magnus", "Ito, Shu"}
Dim names3() As String =
{"Solanki, Ajay", "Hoeing, Helge", "Andersen, Henriette Thaulow", "Potra, Cristina", "Iallo, Lucio"}

' Create a List that contains 3 elements, where
' each element is an array of strings.
Dim namesList As New List(Of String())(New String()() {names1, names2, names3})

' Select arrays that have four or more elements and union
' them into one collection, using Empty() to generate the 
' empty collection for the seed value.
Dim allNames As IEnumerable(Of String) =
namesList.Aggregate(Enumerable.Empty(Of String)(),
                    Function(current, nextOne) _
                        IIf(nextOne.Length > 3, current.Union(nextOne), current))

Dim output As New System.Text.StringBuilder
For Each name As String In allNames

' Display the output.

' This code produces the following output:
' Adams, Terry
' Andersen, Henriette Thaulow
' Hedlund, Magnus
' Ito, Shu
' Solanki, Ajay
' Hoeing, Helge
' Potra, Cristina
' Iallo, Lucio

Universal Windows Platform
Available since 8
.NET Framework
Available since 3.5
Portable Class Library
Supported in: portable .NET platforms
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1
Return to top