Export (0) Print
Expand All

Queryable.Single(TSource) Method (IQueryable(TSource), Expression(Func(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.

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

static member Single : 
        source:IQueryable<'TSource> * 
        predicate:Expression<Func<'TSource, bool>> -> 'TSource 

Type Parameters

TSource

The type of the elements of source.

Parameters

source
Type: System.Linq.IQueryable(TSource)

An IQueryable(T) to return a single element from.

predicate
Type: System.Linq.Expressions.Expression(Func(TSource, Boolean))

A function to test an element for a condition.

Return Value

Type: TSource
The single element of the input sequence that satisfies the condition in predicate.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IQueryable(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

source or predicate is a null reference (Nothing in Visual Basic).

InvalidOperationException

No element satisfies the condition in predicate.

-or-

More than one element satisfies the condition in predicate.

-or-

The source sequence is empty.

This method has at least one parameter of type Expression(TDelegate) whose type argument is one of the Func(T, TResult) types. For these parameters, you can pass in a lambda expression and it will be compiled to an Expression(TDelegate).

The Single(TSource)(IQueryable(TSource), Expression(Func(TSource, Boolean))) method generates a MethodCallExpression that represents calling Single(TSource)(IQueryable(TSource), Expression(Func(TSource, Boolean))) itself as a constructed generic method. It then passes the MethodCallExpression to the Execute(TResult)(Expression) method of the IQueryProvider represented by the Provider property of the source parameter.

The query behavior that occurs as a result of executing an expression tree that represents calling Single(TSource)(IQueryable(TSource), Expression(Func(TSource, Boolean))) depends on the implementation of the type of the source parameter. The expected behavior is that it returns the only element in source that satisfies the condition specified by predicate.

The following code example demonstrates how to use Single(TSource)(IQueryable(TSource), Expression(Func(TSource, Boolean))) to select the only element of an array that satisfies a condition.

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

Portable Class Library

Supported in: Portable Class Library

Supported in: Windows Phone 8.1

Supported in: Windows Phone Silverlight 8.1

Supported in: Windows Phone Silverlight 8
Show:
© 2015 Microsoft