Enumerable.SingleOrDefault Méthode

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.

Surcharges

SingleOrDefault<TSource>(IEnumerable<TSource>, 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.

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.

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.

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

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.

SingleOrDefault<TSource>(IEnumerable<TSource>, 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.

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

Paramètres de type

TSource

Le type des éléments de source.

Paramètres

source
IEnumerable<TSource>

IEnumerable<T> duquel retourner le seul élément.

defaultValue
TSource

Valeur par défaut à retourner si la séquence est vide.

Retours

TSource

Élément unique de la séquence d’entrée, ou defaultValue si la séquence ne contient aucun élément.

Exceptions

source a la valeur null.

La séquence d'entrée contient plusieurs éléments.

S’applique à

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.

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);
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.

Paramètres

source
IEnumerable<TSource>

IEnumerable<T> duquel retourner le seul élément.

Retours

TSource

L'élément unique de la séquence d'entrée ou default (TSource) si la séquence ne contient aucun élément.

Exceptions

source a la valeur null.

La séquence d'entrée contient plusieurs éléments.

Exemples

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

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}")

L’exemple de code suivant montre comment SingleOrDefault<TSource>(IEnumerable<TSource>) retourne une valeur par défaut lorsque la séquence est vide.

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

Parfois, la valeur de default(TSource) n’est pas la valeur par défaut que vous souhaitez utiliser si la collection ne contient aucun élément. Au lieu de vérifier le résultat de la valeur par défaut indésirable, puis de le modifier si nécessaire, vous pouvez utiliser la DefaultIfEmpty<TSource>(IEnumerable<TSource>, TSource) méthode pour spécifier la valeur par défaut que vous souhaitez utiliser si la collection est vide. Ensuite, appelez Single<TSource>(IEnumerable<TSource>) pour obtenir l’élément. 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. É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. 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. La deuxième variable de résultat est obtenue à l’aide DefaultIfEmpty<TSource>(IEnumerable<TSource>, TSource) de pour spécifier une valeur par défaut 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

Remarques

La valeur par défaut pour les types de référence et Nullable est null .

La SingleOrDefault méthode n’offre aucun moyen de spécifier une valeur par défaut. 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.

S’applique à

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.

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);
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.

Paramètres

source
IEnumerable<TSource>

IEnumerable<T> duquel retourner un seul élément.

predicate
Func<TSource,Boolean>

Fonction permettant de tester un élément pour une condition.

Retours

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é.

Exceptions

source ou predicate est null.

Plusieurs éléments satisfont à la condition dans 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.

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}")

L’exemple de code suivant montre comment SingleOrDefault<TSource>(IEnumerable<TSource>, Func<TSource,Boolean>) retourne une valeur par défaut lorsque la séquence ne contient aucun élément répondant à la 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)
Console.WriteLine($"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 et Nullable est null .

S’applique à

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

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.

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

Paramètres de type

TSource

Le type des éléments de source.

Paramètres

source
IEnumerable<TSource>

IEnumerable<T> duquel retourner un seul élément.

predicate
Func<TSource,Boolean>

Fonction permettant de tester un élément pour une condition.

defaultValue
TSource

Valeur par défaut à retourner si la séquence est vide.

Retours

TSource

Élément unique de la séquence d’entrée qui satisfait à la condition, ou defaultValue si aucun élément de ce type n’est trouvé.

Exceptions

source ou predicate est null.

Plusieurs éléments satisfont à la condition dans predicate.

S’applique à