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

Définition

Retourne un élément spécifique unique d'une séquence, ou une valeur par défaut si cet élément est introuvable.Returns a single, specific element of a sequence, or a default value if that element is not found.

Surcharges

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

Retourne l'élément unique d'une séquence ou une valeur par défaut. Cette méthode lève une exception si cette séquence contient plusieurs éléments.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>)

Retourne l’élément unique d’une séquence ou une valeur par défaut si cette séquence ne contient pas d’élément respectant cette condition. Cette méthode lève une exception si cette séquence contient plusieurs éléments satisfaisant à cette condition.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>)

Retourne l'élément unique d'une séquence ou une valeur par défaut. Cette méthode lève une exception si cette séquence contient plusieurs éléments.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

Paramètres de type

TSource

Le type des éléments de source.The type of the elements of source.

Paramètres

source
IEnumerable<TSource>

IEnumerable<T> duquel retourner le seul élément.An IEnumerable<T> to return the single element of.

Retours

TSource TSource TSource TSource

L'élément unique de la séquence d'entrée ou default (TSource) si la séquence ne contient aucun élément.The single element of the input sequence, or default(TSource) if the sequence contains no elements.

Exceptions

La séquence d'entrée contient plusieurs éléments.The input sequence contains more than one element.

Exemples

L’exemple de code suivant montre comment utiliser SingleOrDefault<TSource>(IEnumerable<TSource>) pour sélectionner le seul élément d’un tableau.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)

L’exemple de code suivant montre SingleOrDefault<TSource>(IEnumerable<TSource>) comment retourne une valeur par défaut lorsque la séquence ne contient pas exactement un élément.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

Parfois, la valeur default(TSource) de n’est pas la valeur par défaut que vous souhaitez utiliser si la collection ne contient aucun élément.Sometimes the value of default(TSource) is not the default value that you want to use if the collection contains no elements. Au lieu de vérifier le résultat de la valeur par défaut indésirable, puis de le modifier si nécessaire, vous DefaultIfEmpty<TSource>(IEnumerable<TSource>, TSource) pouvez utiliser la méthode pour spécifier la valeur par défaut que vous souhaitez utiliser si la collection est vide.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. Ensuite, appelez Single<TSource>(IEnumerable<TSource>) pour obtenir l’élément.Then, call Single<TSource>(IEnumerable<TSource>) to obtain the element. L’exemple de code suivant utilise les deux techniques pour obtenir une valeur par défaut de 1 si une collection de numéros de page est vide.The following code example uses both techniques to obtain a default value of 1 if a collection of page numbers is empty. Étant donné que la valeur par défaut d’un entier est 0, ce qui n’est généralement pas un numéro de page valide, la valeur par défaut doit être spécifiée en tant que valeur 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. La valeur par défaut de la première variable de résultat est vérifiée une fois que l’exécution de la requête est terminée.The first result variable is checked for the unwanted default value after the query has finished executing. La deuxième variable de résultat est obtenue à DefaultIfEmpty<TSource>(IEnumerable<TSource>, TSource) l’aide de pour spécifier une valeur par défaut 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

Remarques

La valeur par défaut pour les types de référence nullet Nullable est.The default value for reference and nullable types is null.

La SingleOrDefault méthode n’offre aucun moyen de spécifier une valeur par défaut.The SingleOrDefault method does not provide a way to specify a default value. Si vous souhaitez spécifier une valeur par défaut autre que default(TSource), utilisez la DefaultIfEmpty<TSource>(IEnumerable<TSource>, TSource) méthode comme décrit dans la section exemple.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>)

Retourne l’élément unique d’une séquence ou une valeur par défaut si cette séquence ne contient pas d’élément respectant cette condition. Cette méthode lève une exception si cette séquence contient plusieurs éléments satisfaisant à cette condition.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

Paramètres de type

TSource

Le type des éléments de source.The type of the elements of source.

Paramètres

source
IEnumerable<TSource>

IEnumerable<T> duquel retourner un seul élément.An IEnumerable<T> to return a single element from.

predicate
Func<TSource,Boolean>

Fonction permettant de tester un élément pour une condition.A function to test an element for a condition.

Retours

TSource TSource TSource TSource

Seul élément de la séquence d'entrée à satisfaire à la condition ou default (TSource) si cet élément n'est pas trouvé.The single element of the input sequence that satisfies the condition, or default(TSource) if no such element is found.

Exceptions

source ou predicate est null.source or predicate is null.

Plusieurs éléments satisfont à la condition dans predicate.More than one element satisfies the condition in predicate.

Exemples

L’exemple de code suivant montre comment utiliser SingleOrDefault<TSource>(IEnumerable<TSource>, Func<TSource,Boolean>) pour sélectionner le seul élément d’un tableau qui satisfait à une condition.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)

L’exemple de code suivant montre SingleOrDefault<TSource>(IEnumerable<TSource>, Func<TSource,Boolean>) que retourne une valeur par défaut lorsque la séquence ne contient pas exactement un élément qui satisfait à la condition.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

Remarques

La valeur par défaut pour les types de référence nullet Nullable est.The default value for reference and nullable types is null.

S’applique à