Enumerable.SingleOrDefault Enumerable.SingleOrDefault Enumerable.SingleOrDefault Enumerable.SingleOrDefault Method

Definición

Devuelve un único elemento concreto de una secuencia o un valor predeterminado si no se encuentra ese elemento.Returns a single, specific element of a sequence, or a default value if that element is not found.

Sobrecargas

SingleOrDefault<TSource>(IEnumerable<TSource>) SingleOrDefault<TSource>(IEnumerable<TSource>) SingleOrDefault<TSource>(IEnumerable<TSource>) 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.Returns the only element of a sequence, or a default value if the sequence is empty; this method throws an exception if there is more than one element in the sequence.

SingleOrDefault<TSource>(IEnumerable<TSource>, Func<TSource,Boolean>) SingleOrDefault<TSource>(IEnumerable<TSource>, Func<TSource,Boolean>) SingleOrDefault<TSource>(IEnumerable<TSource>, Func<TSource,Boolean>) 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.Returns the only element of a sequence that satisfies a specified condition or a default value if no such element exists; this method throws an exception if more than one element satisfies the condition.

SingleOrDefault<TSource>(IEnumerable<TSource>) SingleOrDefault<TSource>(IEnumerable<TSource>) SingleOrDefault<TSource>(IEnumerable<TSource>) 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.Returns the only element of a sequence, or a default value if the sequence is empty; this method throws an exception if there is more than one element in the sequence.

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.The type of the elements of source.

Parámetros

source
IEnumerable<TSource>

IEnumerable<T> cuyo único elemento se va a devolver.An IEnumerable<T> to return the single element of.

Devoluciones

TSource TSource TSource TSource

El único elemento de la secuencia de entrada o default(TSource) si la secuencia no contiene ningún elemento.The single element of the input sequence, or default(TSource) if the sequence contains no elements.

Excepciones

La secuencia de entrada contiene más de un elemento.The input sequence contains more than one element.

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.The following code example demonstrates how to use SingleOrDefault<TSource>(IEnumerable<TSource>) to select the only element of an array.

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.
MsgBox("First array: " & result)

En el ejemplo de código siguiente se muestra que SingleOrDefault<TSource>(IEnumerable<TSource>) devuelve un valor predeterminado cuando la secuencia no contiene exactamente un elemento.The following code example demonstrates that SingleOrDefault<TSource>(IEnumerable<TSource>) returns a default value when the sequence does not contain exactly one element.

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)
MsgBox("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 se va a usar si la colección no contiene ningún elemento.Sometimes the value of default(TSource) is not the default value that you want to use if the collection contains no elements. En lugar de comprobar el resultado para el valor predeterminado no deseados y, a continuación, cambiarla si fuera necesario, puede usar el DefaultIfEmpty<TSource>(IEnumerable<TSource>, TSource) método para especificar el valor predeterminado que se va a usar si la colección está vacía.Instead of checking the result for the unwanted default value and then changing it if necessary, you can use the DefaultIfEmpty<TSource>(IEnumerable<TSource>, TSource) method to specify the default value that you want to use if the collection is empty. A continuación, llame a Single<TSource>(IEnumerable<TSource>) para obtener el elemento.Then, call Single<TSource>(IEnumerable<TSource>) to obtain the element. En el siguiente ejemplo utiliza ambas técnicas para obtener un valor predeterminado de 1 si una colección de números de página está vacía.The following code example uses both techniques to obtain a default value of 1 if a collection of page numbers is empty. Dado que el valor predeterminado de un entero es 0, lo que no es normalmente un número de página válido, el valor predeterminado debe especificarse como 1.Because the default value for an integer is 0, which is not usually a valid page number, the default value must be specified as 1 instead. Después de la consulta ha terminado de ejecutarse, se comprueba la primera variable de resultado para el valor predeterminado no deseados.The first result variable is checked for the unwanted default value after the query has finished executing. La segunda variable de resultado se obtiene mediante DefaultIfEmpty<TSource>(IEnumerable<TSource>, TSource) para especificar un valor predeterminado de 1.The second result variable is obtained by using DefaultIfEmpty<TSource>(IEnumerable<TSource>, TSource) to specify a default value of 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
MsgBox(String.Format("The value of the pageNumber1 variable is {0}", pageNumber1))

' Setting the default value to 1 by using DefaultIfEmpty() in the query.
Dim pageNumber2 As Integer = pageNumbers.DefaultIfEmpty(1).Single()
MsgBox(String.Format("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

Comentarios

El valor predeterminado de referencia y tipos que aceptan valores NULL es null.The default value for reference and nullable types is null.

El SingleOrDefault método no proporciona una manera de especificar un valor predeterminado.The SingleOrDefault method does not provide a way to specify a default value. Si desea especificar un valor predeterminado distinto default(TSource), utilice el DefaultIfEmpty<TSource>(IEnumerable<TSource>, TSource) método tal como se describe en la sección ejemplo.If you want to specify a default value other than default(TSource), use the DefaultIfEmpty<TSource>(IEnumerable<TSource>, TSource) method as described in the Example section.

SingleOrDefault<TSource>(IEnumerable<TSource>, Func<TSource,Boolean>) SingleOrDefault<TSource>(IEnumerable<TSource>, Func<TSource,Boolean>) SingleOrDefault<TSource>(IEnumerable<TSource>, Func<TSource,Boolean>) 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.Returns the only element of a sequence that satisfies a specified condition or a default value if no such element exists; this method throws an exception if more than one element satisfies the condition.

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.The type of the elements of source.

Parámetros

source
IEnumerable<TSource>

IEnumerable<T> del que se va a devolver un único elemento.An IEnumerable<T> to return a single element from.

predicate
Func<TSource,Boolean>

Función que va a probar si un elemento satisface una condición.A function to test an element for a condition.

Devoluciones

TSource TSource TSource TSource

El único elemento de la secuencia de entrada que satisface la condición o default(TSource) si no se encuentra dicho elemento.The single element of the input sequence that satisfies the condition, or default(TSource) if no such element is found.

Excepciones

source o predicate es null.source or predicate is null.

Varios elementos satisfacen la condición de predicate.More than one element satisfies the condition in 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 satisface una condición.The following code example demonstrates how to use SingleOrDefault<TSource>(IEnumerable<TSource>, Func<TSource,Boolean>) to select the only element of an array that satisfies a condition.

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.
MsgBox("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 exactamente un elemento que satisface la condición.The following code example demonstrates that SingleOrDefault<TSource>(IEnumerable<TSource>, Func<TSource,Boolean>) returns a default value when the sequence does not contain exactly one element that satisfies the condition.

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)
MsgBox("Second array: " & output)

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

Comentarios

El valor predeterminado de referencia y tipos que aceptan valores NULL es null.The default value for reference and nullable types is null.

Se aplica a