Queryable.SingleOrDefault Méthode

Définition

Espace de noms:

System.Linq

Assembly:

System.Linq.Queryable.dll

Retourne un élément spécifique unique d'une séquence, ou une valeur par défaut si cet élément n'est pas trouvé.

Surcharges

SingleOrDefault<TSource>(IQueryable<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>(IQueryable<TSource>, Expression<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>(IQueryable<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>(IQueryable<TSource>, Expression<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>(IQueryable<TSource>, TSource)

Source:

Queryable.cs

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::Linq::IQueryable<TSource> ^ source, TSource defaultValue);

public static TSource SingleOrDefault<TSource> (this System.Linq.IQueryable<TSource> source, TSource defaultValue);

static member SingleOrDefault : System.Linq.IQueryable<'Source> * 'Source -> 'Source

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

Paramètres de type

TSource

Le type des éléments de source.

Paramètres

source

IQueryable<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

ArgumentNullException

source a la valeur null.

InvalidOperationException

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

SingleOrDefault<TSource>(IQueryable<TSource>, Expression<Func<TSource,Boolean>>, TSource)

Source:

Queryable.cs

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::Linq::IQueryable<TSource> ^ source, System::Linq::Expressions::Expression<Func<TSource, bool> ^> ^ predicate, TSource defaultValue);

public static TSource SingleOrDefault<TSource> (this System.Linq.IQueryable<TSource> source, System.Linq.Expressions.Expression<Func<TSource,bool>> predicate, TSource defaultValue);

static member SingleOrDefault : System.Linq.IQueryable<'Source> * System.Linq.Expressions.Expression<Func<'Source, bool>> * 'Source -> 'Source

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

Paramètres de type

TSource

Le type des éléments de source.

Paramètres

source

IQueryable<TSource>

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

predicate

Expression<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 remplit la condition, ou defaultValue si aucun élément de ce type n’est trouvé.

Exceptions

ArgumentNullException

source ou predicate est null.

InvalidOperationException

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

SingleOrDefault<TSource>(IQueryable<TSource>)

Source:

Queryable.cs

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::Linq::IQueryable<TSource> ^ source);

public static TSource? SingleOrDefault<TSource> (this System.Linq.IQueryable<TSource> source);

static member SingleOrDefault : System.Linq.IQueryable<'Source> -> 'Source

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

Paramètres de type

TSource

Le type des éléments de source.

Paramètres

source

IQueryable<TSource>

IQueryable<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

ArgumentNullException

source a la valeur null.

InvalidOperationException

source a plusieurs éléments.

Exemples

L’exemple de code suivant montre comment utiliser SingleOrDefault<TSource>(IQueryable<TSource>) pour sélectionner le seul élément d’un tableau. La deuxième requête montre que SingleOrDefault<TSource>(IQueryable<TSource>) retourne une valeur par défaut lorsque la séquence ne contient pas exactement un élément.

// Create two arrays. The second is empty.
string[] fruits1 = { "orange" };
string[] fruits2 = { };

// Get the only item in the first array, or else
// the default value for type string (null).
string fruit1 = fruits1.AsQueryable().SingleOrDefault();
Console.WriteLine("First Query: " + fruit1);

// Get the only item in the second array, or else
// the default value for type string (null).
string fruit2 = fruits2.AsQueryable().SingleOrDefault();
Console.WriteLine("Second Query: " +
    (String.IsNullOrEmpty(fruit2) ? "No such string!" : fruit2));

/*
    This code produces the following output:

    First Query: orange
    Second Query: No such string!
*/

' Create two arrays. The second is empty.
Dim fruits1() As String = {"orange"}
Dim fruits2() As String = {}

' Get the only item in the first array, or else
' the default value for type string (null).
Dim fruit1 As String = fruits1.AsQueryable().SingleOrDefault()
MsgBox("First Query: " + fruit1)

' Get the only item in the second array, or else
' the default value for type string (null). 
Dim fruit2 As String = fruits2.AsQueryable().SingleOrDefault()
MsgBox("Second Query: " & _
    IIf(String.IsNullOrEmpty(fruit2), "No such string!", fruit2))

' This code produces the following output:

' First Query: orange
' Second Query: No such string!

Parfois, la valeur de n’est default(TSource) 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 pour la valeur par défaut indésirable et de la modifier si nécessaire, vous pouvez utiliser la DefaultIfEmpty<TSource>(IQueryable<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>(IQueryable<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, qui n’est généralement pas un numéro de page valide, la valeur par défaut doit être spécifiée comme 1 à la place. La première variable de résultat est vérifiée pour la valeur par défaut indésirable une fois la requête terminée. La deuxième variable de résultat est obtenue en appelant DefaultIfEmpty<TSource>(IQueryable<TSource>, TSource) pour spécifier la valeur par défaut 1.

int[] pageNumbers = { };

// Setting the default value to 1 after the query.
int pageNumber1 = pageNumbers.AsQueryable().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.AsQueryable().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.AsQueryable().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.AsQueryable().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 SingleOrDefault<TSource>(IQueryable<TSource>) méthode génère un MethodCallExpression qui représente l’appel SingleOrDefault<TSource>(IQueryable<TSource>) en tant que méthode générique construite. Il passe ensuite à MethodCallExpression la Execute<TResult>(Expression) méthode du IQueryProvider représenté par la Provider propriété du source paramètre .

Le comportement de requête qui se produit à la suite de l’exécution d’une arborescence d’expressions qui représente l’appel SingleOrDefault<TSource>(IQueryable<TSource>) dépend de l’implémentation du type du source paramètre. Le comportement attendu est qu’il retourne le seul élément dans source, ou une valeur par défaut si source est vide.

La SingleOrDefault méthode ne permet pas 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>(IQueryable<TSource>, TSource) méthode comme décrit dans la section Exemple.

SingleOrDefault<TSource>(IQueryable<TSource>, Expression<Func<TSource,Boolean>>)

Source:

Queryable.cs

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::Linq::IQueryable<TSource> ^ source, System::Linq::Expressions::Expression<Func<TSource, bool> ^> ^ predicate);

public static TSource? SingleOrDefault<TSource> (this System.Linq.IQueryable<TSource> source, System.Linq.Expressions.Expression<Func<TSource,bool>> predicate);

static member SingleOrDefault : System.Linq.IQueryable<'Source> * System.Linq.Expressions.Expression<Func<'Source, bool>> -> 'Source

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

Paramètres de type

TSource

Le type des éléments de source.

Paramètres

source

IQueryable<TSource>

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

predicate

Expression<Func<TSource,Boolean>>

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

Retours

TSource

Élément unique de la séquence d’entrée qui remplit la condition dans predicate, ou default(TSource) si aucun élément de ce type n’est trouvé.

Exceptions

ArgumentNullException

source ou predicate est null.

InvalidOperationException

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

Exemples

L’exemple de code suivant montre comment utiliser SingleOrDefault<TSource>(IQueryable<TSource>, Expression<Func<TSource,Boolean>>) pour sélectionner le seul élément d’un tableau qui répond à une condition. La deuxième requête montre que SingleOrDefault<TSource>(IQueryable<TSource>, Expression<Func<TSource,Boolean>>) retourne une valeur par défaut lorsque la séquence ne contient pas exactement un élément qui satisfait à la condition.

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

// Get the single string in the array whose length is greater
// than 10, or else the default value for type string (null).
string fruit1 =
    fruits.AsQueryable().SingleOrDefault(fruit => fruit.Length > 10);
Console.WriteLine("First Query: " + fruit1);

// Get the single string in the array whose length is greater
// than 15, or else the default value for type string (null).
string fruit2 =
   fruits.AsQueryable().SingleOrDefault(fruit => fruit.Length > 15);
Console.WriteLine("Second Query: " +
    (String.IsNullOrEmpty(fruit2) ? "No such string!" : fruit2));

/*
    This code produces the following output:

    First Query: passionfruit
    Second Query: No such string!
*/

Dim fruits() As String = _
    {"apple", "banana", "mango", "orange", "passionfruit", "grape"}

' Get the single string in the array whose length is greater
' than 10, or else the default value for type string (null).
Dim fruit1 As String = _
    fruits.AsQueryable().SingleOrDefault(Function(fruit) fruit.Length > 10)
' Display the result.
MsgBox("First Query: " & fruit1)

' Get the single string in the array whose length is greater
' than 15, or else the default value for type string (null).
Dim fruit2 As String = _
    fruits.AsQueryable().SingleOrDefault(Function(fruit) fruit.Length > 15)
MsgBox("Second Query: " & _
    IIf(String.IsNullOrEmpty(fruit2), "No such string!", fruit2))

' This code produces the following output:

' First Query: passionfruit
' Second Query: No such string!

Remarques

Cette méthode a au moins un paramètre de type Expression<TDelegate> dont l’argument type est l’un Func<T,TResult> des types. Pour ces paramètres, vous pouvez passer une expression lambda et elle sera compilée dans un Expression<TDelegate>.

La SingleOrDefault<TSource>(IQueryable<TSource>, Expression<Func<TSource,Boolean>>) méthode génère un MethodCallExpression qui représente l’appel SingleOrDefault<TSource>(IQueryable<TSource>, Expression<Func<TSource,Boolean>>) en tant que méthode générique construite. Il passe ensuite à MethodCallExpression la Execute<TResult>(Expression) méthode du IQueryProvider représenté par la Provider propriété du source paramètre .

Le comportement de requête qui se produit à la suite de l’exécution d’une arborescence d’expressions qui représente l’appel SingleOrDefault<TSource>(IQueryable<TSource>, Expression<Func<TSource,Boolean>>) dépend de l’implémentation du type du source paramètre. Le comportement attendu est qu’il retourne le seul élément dans source qui remplit la condition spécifiée par predicate, ou une valeur par défaut si aucun élément de ce type n’existe.