Enumerable.SingleOrDefault Método

Definición

Espacio de nombres:

System.Linq

Ensamblado:

System.Linq.dll

Devuelve un único elemento concreto de una secuencia o un valor predeterminado si no se encuentra ese elemento.

Sobrecargas

SingleOrDefault<TSource>(IEnumerable<TSource>)	Devuelve el único elemento de una secuencia o un valor predeterminado si la secuencia está vacía; este método produce una excepción si hay más de un elemento en la secuencia.
SingleOrDefault<TSource>(IEnumerable<TSource>, Func<TSource,Boolean>)	Devuelve el único elemento de una secuencia que cumpla la condición especificada, o bien, un valor predeterminado si ese elemento no existe; este método produce una excepción si varios elementos cumplen la condición.
SingleOrDefault<TSource>(IEnumerable<TSource>, TSource)	Devuelve el único elemento de una secuencia o un valor predeterminado especificado si la secuencia está vacía; Este método produce una excepción si hay más de un elemento en la secuencia.
SingleOrDefault<TSource>(IEnumerable<TSource>, Func<TSource,Boolean>, TSource)	Devuelve el único elemento de una secuencia que satisface una condición especificada o un valor predeterminado especificado si no existe dicho elemento; Este método produce una excepción si más de un elemento cumple la condición.

SingleOrDefault<TSource>(IEnumerable<TSource>)

Source:

Single.cs

Devuelve el único elemento de una secuencia o un valor predeterminado si la secuencia está vacía; este método produce una excepción si hay más de un elemento en la secuencia.

public:
generic <typename TSource>
[System::Runtime::CompilerServices::Extension]
 static TSource SingleOrDefault(System::Collections::Generic::IEnumerable<TSource> ^ source);

public static TSource? SingleOrDefault<TSource> (this System.Collections.Generic.IEnumerable<TSource> source);

static member SingleOrDefault : seq<'Source> -> 'Source

<Extension()>
Public Function SingleOrDefault(Of TSource) (source As IEnumerable(Of TSource)) As TSource

Parámetros de tipo

TSource

Tipo de los elementos de source.

Parámetros

source

IEnumerable<TSource>

IEnumerable<T> cuyo único elemento se va a devolver.

Devoluciones

TSource

El único elemento de la secuencia de entrada o default(TSource) si la secuencia no contiene ningún elemento.

Excepciones

ArgumentNullException

source es null.

InvalidOperationException

La secuencia de entrada contiene más de un elemento.

Ejemplos

En el ejemplo de código siguiente se muestra cómo usar SingleOrDefault<TSource>(IEnumerable<TSource>) para seleccionar el único elemento de una matriz.

string[] fruits1 = { "orange" };

string fruit1 = fruits1.SingleOrDefault();

Console.WriteLine(fruit1);

/*
 This code produces the following output:

 orange
*/

' Create an array that contains one item.
Dim fruits1() As String = {"orange"}

' Get the single item in the array or else a default value.
Dim result As String = fruits1.SingleOrDefault()

' Display the result.
Console.WriteLine($"First array: {result}")

En el ejemplo de código siguiente se muestra que SingleOrDefault<TSource>(IEnumerable<TSource>) devuelve un valor predeterminado cuando la secuencia está vacía.

string[] fruits2 = { };

string fruit2 = fruits2.SingleOrDefault();

Console.WriteLine(
    String.IsNullOrEmpty(fruit2) ? "No such string!" : fruit2);

/*
 This code produces the following output:

 No such string!
*/

' Create an empty array.
Dim fruits2() As String = {}

result = String.Empty

' Get the single item in the array or else a default value.
result = fruits2.SingleOrDefault()

' Display the result.
Dim output As String =
IIf(String.IsNullOrEmpty(result), "No single item found", result)
Console.WriteLine($"Second array: {output}")

' This code produces the following output:
'
' First array: orange
' Second array: No single item found

A veces, el valor de default(TSource) no es el valor predeterminado que desea usar si la colección no contiene ningún elemento. En lugar de comprobar el resultado del valor predeterminado no deseado y, a continuación, cambiarlo si es necesario, puede usar el DefaultIfEmpty<TSource>(IEnumerable<TSource>, TSource) método para especificar el valor predeterminado que desea usar si la colección está vacía. A continuación, llame Single<TSource>(IEnumerable<TSource>) a para obtener el elemento . En el ejemplo de código siguiente se usan ambas técnicas para obtener un valor predeterminado de 1 si una colección de números de página está vacía. Dado que el valor predeterminado de un entero es 0, que normalmente no es un número de página válido, el valor predeterminado debe especificarse como 1 en su lugar. La primera variable de resultado se comprueba para el valor predeterminado no deseado después de que la consulta haya terminado de ejecutarse. La segunda variable de resultado se obtiene mediante DefaultIfEmpty<TSource>(IEnumerable<TSource>, TSource) para especificar un valor predeterminado de 1.

int[] pageNumbers = { };

// Setting the default value to 1 after the query.
int pageNumber1 = pageNumbers.SingleOrDefault();
if (pageNumber1 == 0)
{
    pageNumber1 = 1;
}
Console.WriteLine("The value of the pageNumber1 variable is {0}", pageNumber1);

// Setting the default value to 1 by using DefaultIfEmpty() in the query.
int pageNumber2 = pageNumbers.DefaultIfEmpty(1).Single();
Console.WriteLine("The value of the pageNumber2 variable is {0}", pageNumber2);

/*
 This code produces the following output:

 The value of the pageNumber1 variable is 1
 The value of the pageNumber2 variable is 1
*/

Dim pageNumbers() As Integer = {}

' Setting the default value to 1 after the query.
Dim pageNumber1 As Integer = pageNumbers.SingleOrDefault()
If pageNumber1 = 0 Then
    pageNumber1 = 1
End If
Console.WriteLine($"The value of the pageNumber1 variable is {pageNumber1}")

' Setting the default value to 1 by using DefaultIfEmpty() in the query.
Dim pageNumber2 As Integer = pageNumbers.DefaultIfEmpty(1).Single()
Console.WriteLine($"The value of the pageNumber2 variable is {pageNumber2}")

' This code produces the following output:

' The value of the pageNumber1 variable is 1
' The value of the pageNumber2 variable is 1

Comentarios

El valor predeterminado para los tipos de referencia y que aceptan valores NULL es null.

El SingleOrDefault método no proporciona una manera de especificar un valor predeterminado. Si desea especificar un valor predeterminado distinto default(TSource)de , use el DefaultIfEmpty<TSource>(IEnumerable<TSource>, TSource) método como se describe en la sección Ejemplo.

SingleOrDefault<TSource>(IEnumerable<TSource>, Func<TSource,Boolean>)

Source:

Single.cs

Devuelve el único elemento de una secuencia que cumpla la condición especificada, o bien, un valor predeterminado si ese elemento no existe; este método produce una excepción si varios elementos cumplen la condición.

public:
generic <typename TSource>
[System::Runtime::CompilerServices::Extension]
 static TSource SingleOrDefault(System::Collections::Generic::IEnumerable<TSource> ^ source, Func<TSource, bool> ^ predicate);

public static TSource? SingleOrDefault<TSource> (this System.Collections.Generic.IEnumerable<TSource> source, Func<TSource,bool> predicate);

static member SingleOrDefault : seq<'Source> * Func<'Source, bool> -> 'Source

<Extension()>
Public Function SingleOrDefault(Of TSource) (source As IEnumerable(Of TSource), predicate As Func(Of TSource, Boolean)) As TSource

Parámetros de tipo

TSource

Tipo de los elementos de source.

Parámetros

source

IEnumerable<TSource>

IEnumerable<T> del que se va a devolver un único elemento.

predicate

Func<TSource,Boolean>

Función que va a probar si un elemento satisface una condición.

Devoluciones

TSource

El único elemento de la secuencia de entrada que satisface la condición o default(TSource) si no se encuentra dicho elemento.

Excepciones

ArgumentNullException

source o predicate es null.

InvalidOperationException

Varios elementos satisfacen la condición de predicate.

Ejemplos

En el ejemplo de código siguiente se muestra cómo usar SingleOrDefault<TSource>(IEnumerable<TSource>, Func<TSource,Boolean>) para seleccionar el único elemento de una matriz que cumpla una condición.

string[] fruits = { "apple", "banana", "mango",
                      "orange", "passionfruit", "grape" };

string fruit1 = fruits.SingleOrDefault(fruit => fruit.Length > 10);

Console.WriteLine(fruit1);

/*
 This code produces the following output:

 passionfruit
*/

' 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 > 10.
Dim fruit1 As String =
fruits.SingleOrDefault(Function(fruit) fruit.Length > 10)

' Display the result.
Console.WriteLine($"First array: {fruit1}")

En el ejemplo de código siguiente se muestra que SingleOrDefault<TSource>(IEnumerable<TSource>, Func<TSource,Boolean>) devuelve un valor predeterminado cuando la secuencia no contiene elementos que cumplan la condición.

string fruit2 =
    fruits.SingleOrDefault(fruit => fruit.Length > 15);

Console.WriteLine(
    String.IsNullOrEmpty(fruit2) ? "No such string!" : fruit2);

/*
 This code produces the following output:

 No such string!
*/

' Get the single item in the array whose length is > 15.
Dim fruit2 As String =
fruits.SingleOrDefault(Function(fruit) fruit.Length > 15)

' Display the result.
Dim output As String =
IIf(String.IsNullOrEmpty(fruit2), "No single item found", fruit2)
Console.WriteLine($"Second array: {output}")

' This code produces the following output:
'
' First array: passionfruit
' Second array: No single item found

Comentarios

El valor predeterminado para los tipos de referencia y que aceptan valores NULL es null.

SingleOrDefault<TSource>(IEnumerable<TSource>, TSource)

Source:

Single.cs

Devuelve el único elemento de una secuencia o un valor predeterminado especificado si la secuencia está vacía; Este método produce una excepción si hay más de un elemento en la secuencia.

public:
generic <typename TSource>
[System::Runtime::CompilerServices::Extension]
 static TSource SingleOrDefault(System::Collections::Generic::IEnumerable<TSource> ^ source, TSource defaultValue);

public static TSource SingleOrDefault<TSource> (this System.Collections.Generic.IEnumerable<TSource> source, TSource defaultValue);

static member SingleOrDefault : seq<'Source> * 'Source -> 'Source

<Extension()>
Public Function SingleOrDefault(Of TSource) (source As IEnumerable(Of TSource), defaultValue As TSource) As TSource

Parámetros de tipo

TSource

Tipo de los elementos de source.

Parámetros

source

IEnumerable<TSource>

IEnumerable<T> cuyo único elemento se va a devolver.

defaultValue

TSource

Valor predeterminado que se va a devolver si la secuencia está vacía.

Devoluciones

TSource

Elemento único de la secuencia de entrada o defaultValue si la secuencia no contiene ningún elemento.

Excepciones

ArgumentNullException

source es null.

InvalidOperationException

La secuencia de entrada contiene más de un elemento.

SingleOrDefault<TSource>(IEnumerable<TSource>, Func<TSource,Boolean>, TSource)

Source:

Single.cs

Devuelve el único elemento de una secuencia que satisface una condición especificada o un valor predeterminado especificado si no existe dicho elemento; Este método produce una excepción si más de un elemento cumple la condición.

public:
generic <typename TSource>
[System::Runtime::CompilerServices::Extension]
 static TSource SingleOrDefault(System::Collections::Generic::IEnumerable<TSource> ^ source, Func<TSource, bool> ^ predicate, TSource defaultValue);

public static TSource SingleOrDefault<TSource> (this System.Collections.Generic.IEnumerable<TSource> source, Func<TSource,bool> predicate, TSource defaultValue);

static member SingleOrDefault : seq<'Source> * Func<'Source, bool> * 'Source -> 'Source

<Extension()>
Public Function SingleOrDefault(Of TSource) (source As IEnumerable(Of TSource), predicate As Func(Of TSource, Boolean), defaultValue As TSource) As TSource

Parámetros de tipo

TSource

Tipo de los elementos de source.

Parámetros

source

IEnumerable<TSource>

IEnumerable<T> del que se va a devolver un único elemento.

predicate

Func<TSource,Boolean>

Función que va a probar si un elemento satisface una condición.

defaultValue

TSource

Valor predeterminado que se va a devolver si la secuencia está vacía.

Devoluciones

TSource

Elemento único de la secuencia de entrada que satisface la condición o defaultValue si no se encuentra ningún elemento de este tipo.

Excepciones

ArgumentNullException

source o predicate es null.

InvalidOperationException

Varios elementos satisfacen la condición de predicate.