Enumerable.Single(Of TSource) Method (IEnumerable(Of TSource), Func(Of TSource, Boolean))
Returns the only element of a sequence that satisfies a specified condition, and throws an exception if more than one such element exists.
Assembly: System.Core (in System.Core.dll)
'Declaration <ExtensionAttribute> _ Public Shared Function Single(Of TSource) ( _ source As IEnumerable(Of TSource), _ predicate As Func(Of TSource, Boolean) _ ) As TSource 'Usage Dim source As IEnumerable(Of TSource) Dim predicate As Func(Of TSource, Boolean) Dim returnValue As TSource returnValue = source.Single(predicate)
Type Parameters
- TSource
The type of the elements of source.
Parameters
- source
- Type: System.Collections.Generic.IEnumerable(Of TSource)
An IEnumerable(Of T) to return a single element from.
- predicate
- Type: System.Func(Of TSource, Boolean)
A function to test an element for a condition.
Return Value
Type: TSourceThe single element of the input sequence that satisfies a condition.
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 predicate is Nothing. |
| InvalidOperationException | No element satisfies the condition in predicate. -or- More than one element satisfies the condition in predicate. -or- The source sequence is empty. |
The Single(Of TSource)(IEnumerable(Of TSource), Func(Of TSource, Boolean)) method throws an exception if the input sequence contains no matching element. To instead return Nothing when no matching element is found, use SingleOrDefault.
The following code example demonstrates how to use Single(Of TSource)(IEnumerable(Of TSource), Func(Of TSource, Boolean)) to select the only element of an array that satisfies a condition.
' Create an array of strings. Dim fruits() As String = _ {"apple", "banana", "mango", "orange", "passionfruit", "grape"} ' Get the single item in the array whose length is greater than 10. Dim result As String = _ fruits.Single(Function(fruit) fruit.Length > 10) ' Display the result. MsgBox("First query: " & result)
The following code example demonstrates that Single(Of TSource)(IEnumerable(Of TSource), Func(Of TSource, Boolean)) throws an exception when the sequence does not contain exactly one element that satisfies the condition.
result = String.Empty ' Try to get the single item in the array whose length is > 15. Try result = fruits.Single(Function(fruit) _ fruit.Length > 15) Catch ex As System.InvalidOperationException result = "There is not EXACTLY ONE element whose length is > 15." End Try ' Display the result. MsgBox("Second query: " & result) ' This code produces the following output: ' ' First query: passionfruit ' Second query: There is not EXACTLY ONE element whose length is > 15.
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.