Func<TResult> Func<TResult> Func<TResult> Func<TResult> Delegate

Définition

Encapsule une méthode qui n’a pas de paramètre et retourne une valeur du type spécifié par le paramètre TResult.Encapsulates a method that has no parameters and returns a value of the type specified by the TResult parameter.

generic <typename TResult>
public delegate TResult Func();
public delegate TResult Func<out TResult>();
type Func<'Result> = delegate of unit -> 'Result
Public Delegate Function Func(Of Out TResult)() As TResult 

Paramètres de type

TResult

Type de la valeur de retour de la méthode encapsulée par ce délégué.The type of the return value of the method that this delegate encapsulates.

Valeur renvoyée

TResult

Valeur de retour de la méthode encapsulée par ce délégué.The return value of the method that this delegate encapsulates.

Héritage
Func<TResult>Func<TResult>Func<TResult>Func<TResult>

Exemples

L’exemple suivant montre comment utiliser un délégué qui n’accepte aucun paramètre.The following example demonstrates how to use a delegate that takes no parameters. Ce code crée une classe générique nommée LazyValue qui a un champ de type Func<TResult>.This code creates a generic class named LazyValue that has a field of type Func<TResult>. Ce champ délégué peut stocker une référence à n’importe quelle fonction qui retourne une valeur du type qui correspond au paramètre de type de la LazyValue objet.This delegate field can store a reference to any function that returns a value of the type that corresponds to the type parameter of the LazyValue object. Le LazyValue type a également un Value propriété qui exécute la fonction (si elle n’a pas déjà été exécutée) et retourne la valeur résultante.The LazyValue type also has a Value property that executes the function (if it has not already been executed) and returns the resulting value.

L’exemple crée deux méthodes et instancie deux LazyValue objets avec des expressions lambda qui appellent ces méthodes.The example creates two methods and instantiates two LazyValue objects with lambda expressions that call these methods. Les expressions lambda ne prennent pas de paramètres, car ils doivent simplement appeler une méthode.The lambda expressions do not take parameters because they just need to call a method. Comme le montre la sortie, les deux méthodes sont exécutées uniquement lorsque la valeur de chaque LazyValue objet est récupéré.As the output shows, the two methods are executed only when the value of each LazyValue object is retrieved.

using System;

static class Func1
{
   public static void Main()
   {
      // Note that each lambda expression has no parameters.
      LazyValue<int> lazyOne = new LazyValue<int>(() => ExpensiveOne());
      LazyValue<long> lazyTwo = new LazyValue<long>(() => ExpensiveTwo("apple"));

      Console.WriteLine("LazyValue objects have been created.");

      // Get the values of the LazyValue objects.
      Console.WriteLine(lazyOne.Value);
      Console.WriteLine(lazyTwo.Value);
   }
      
   static int ExpensiveOne()
   {
      Console.WriteLine("\nExpensiveOne() is executing.");
      return 1;
   }

   static long ExpensiveTwo(string input)
   {
      Console.WriteLine("\nExpensiveTwo() is executing.");
      return (long)input.Length;
   }
}

class LazyValue<T> where T : struct
{
   private Nullable<T> val;
   private Func<T> getValue;

   // Constructor.
   public LazyValue(Func<T> func)
   {
      val = null;
      getValue = func;
   }

   public T Value
   {
      get
      {
         if (val == null)
            // Execute the delegate.
            val = getValue();
         return (T)val;
      }
   }
}
/* The example produces the following output:

    LazyValue objects have been created.
    
    ExpensiveOne() is executing.
    1
    
    ExpensiveTwo() is executing.
    5
*/    
Public Module Func
   Public Sub Main()
      ' Note that each lambda expression has no parameters.
      Dim lazyOne As New LazyValue(Of Integer)(Function() ExpensiveOne())
      Dim lazyTwo As New LazyValue(Of Long)(Function() ExpensiveTwo("apple")) 

      Console.WriteLine("LazyValue objects have been created.")

      ' Get the values of the LazyValue objects.
      Console.WriteLine(lazyOne.Value)
      Console.WriteLine(lazyTwo.Value)
   End Sub

   Public Function ExpensiveOne() As Integer
      Console.WriteLine()
      Console.WriteLine("ExpensiveOne() is executing.")
      Return 1
   End Function

   Public Function ExpensiveTwo(input As String) As Long
      Console.WriteLine() 
      Console.WriteLine("ExpensiveTwo() is executing.")
      Return input.Length
   End Function
End Module

Public Class LazyValue(Of T As Structure)
   Private val As Nullable(Of T)
   Private getValue As Func(Of T)

   ' Constructor.
   Public Sub New(func As Func(Of T))
      Me.val = Nothing
      Me.getValue = func
   End Sub

   Public ReadOnly Property Value() As T
      Get
         If Me.val Is Nothing Then
            ' Execute the delegate.
            Me.val = Me.getValue()
         End If   
         Return CType(val, T)
      End Get
   End Property
End Class

Remarques

Vous pouvez utiliser ce délégué pour représenter une méthode qui peut être passée en tant que paramètre sans déclarer explicitement un délégué personnalisé.You can use this delegate to represent a method that can be passed as a parameter without explicitly declaring a custom delegate. La méthode encapsulée doit correspondre à la signature de méthode définie par ce délégué.The encapsulated method must correspond to the method signature that is defined by this delegate. Cela signifie que la méthode encapsulée doit avoir aucun paramètre et doit retourner une valeur.This means that the encapsulated method must have no parameters and must return a value.

Note

Pour référencer une méthode qui n’a aucun paramètre et retourne void (ou en Visual Basic, qui est déclaré comme un Sub plutôt que comme un Function), utilisez le Action déléguer à la place.To reference a method that has no parameters and returns void (or in Visual Basic, that is declared as a Sub rather than as a Function), use the Action delegate instead.

Lorsque vous utilisez le Func<TResult> délégué, vous n’avez pas à définir explicitement un délégué qui encapsule une méthode sans paramètre.When you use the Func<TResult> delegate, you do not have to explicitly define a delegate that encapsulates a parameterless method. Par exemple, le code suivant déclare explicitement un délégué nommé WriteMethod et assigne une référence à la OutputTarget.SendToFile méthode à son instance de délégué d’instance.For example, the following code explicitly declares a delegate named WriteMethod and assigns a reference to the OutputTarget.SendToFile instance method to its delegate instance.

using System;
using System.IO;

delegate bool WriteMethod();

public class TestDelegate
{
   public static void Main()
   {
      OutputTarget output = new OutputTarget();
      WriteMethod methodCall = output.SendToFile;
      if (methodCall())
         Console.WriteLine("Success!"); 
      else
         Console.WriteLine("File write operation failed.");
   }
}

public class OutputTarget
{
   public bool SendToFile()
   {
      try
      {
         string fn = Path.GetTempFileName();
         StreamWriter sw = new StreamWriter(fn);
         sw.WriteLine("Hello, World!");
         sw.Close();
         return true;
      }  
      catch
      {
         return false;
      }
   }
}
Imports System.IO

Delegate Function WriteMethod As Boolean

Module TestDelegate
   Public Sub Main()
      Dim output As New OutputTarget()
      Dim methodCall As WriteMethod = AddressOf output.SendToFile
      If methodCall() Then 
         Console.WriteLine("Success!")
      Else
         Console.WriteLine("File write operation failed.")
      End If      
   End Sub
End Module

Public Class OutputTarget
   Public Function SendToFile() As Boolean
      Try
         Dim fn As String = Path.GetTempFileName
         Dim sw As StreamWriter = New StreamWriter(fn)
         sw.WriteLine("Hello, World!")
         sw.Close      
         Return True
      Catch
         Return False
      End Try
   End Function
End Class

L’exemple suivant simplifie ce code en instanciant le Func<TResult> délégué au lieu de définir un nouveau délégué et lui assigner une méthode nommée explicitement.The following example simplifies this code by instantiating the Func<TResult> delegate instead of explicitly defining a new delegate and assigning a named method to it.

using System;
using System.IO;

public class TestDelegate
{
   public static void Main()
   {
      OutputTarget output = new OutputTarget();
      Func<bool> methodCall = output.SendToFile;
      if (methodCall())
         Console.WriteLine("Success!"); 
      else
         Console.WriteLine("File write operation failed.");
   }
}

public class OutputTarget
{
   public bool SendToFile()
   {
      try
      {
         string fn = Path.GetTempFileName();
         StreamWriter sw = new StreamWriter(fn);
         sw.WriteLine("Hello, World!");
         sw.Close();
         return true;
      }  
      catch
      {
         return false;
      }
   }
}
Imports System.IO

Module TestDelegate
   Public Sub Main()
      Dim output As New OutputTarget()
      Dim methodCall As Func(Of Boolean) = AddressOf output.SendToFile
      If methodCall() Then 
         Console.WriteLine("Success!")
      Else
         Console.WriteLine("File write operation failed.")
      End If      
   End Sub
End Module

Public Class OutputTarget
   Public Function SendToFile() As Boolean
      Try
         Dim fn As String = Path.GetTempFileName
         Dim sw As StreamWriter = New StreamWriter(fn)
         sw.WriteLine("Hello, World!")
         sw.Close      
         Return True
      Catch
         Return False
      End Try
   End Function
End Class

Vous pouvez utiliser le Func<TResult> déléguer avec les méthodes anonymes en c#, comme l’illustre l’exemple suivant.You can use the Func<TResult> delegate with anonymous methods in C#, as the following example illustrates. (Pour une introduction aux méthodes anonymes, consultez méthodes anonymes.)(For an introduction to anonymous methods, see Anonymous Methods.)

using System;
using System.IO;

public class Anonymous
{
   public static void Main()
   {
      OutputTarget output = new OutputTarget();
      Func<bool> methodCall = delegate() { return output.SendToFile(); };
      if (methodCall())
         Console.WriteLine("Success!"); 
      else
         Console.WriteLine("File write operation failed.");
   }
}

public class OutputTarget
{
   public bool SendToFile()
   {
      try
      {
         string fn = Path.GetTempFileName();
         StreamWriter sw = new StreamWriter(fn);
         sw.WriteLine("Hello, World!");
         sw.Close();
         return true;
      }  
      catch
      {
         return false;
      }
   }
}

Vous pouvez également affecter une expression lambda à une Func<T,TResult> déléguer, comme l’illustre l’exemple suivant.You can also assign a lambda expression to a Func<T,TResult> delegate, as the following example illustrates. (Pour une introduction aux expressions lambda, consultez Expressions Lambda et Expressions Lambda.)(For an introduction to lambda expressions, see Lambda Expressions and Lambda Expressions.)

using System;
using System.IO;

public class Anonymous
{
   public static void Main()
   {
      OutputTarget output = new OutputTarget();
      Func<bool> methodCall = () => output.SendToFile(); 
      if (methodCall())
         Console.WriteLine("Success!"); 
      else
         Console.WriteLine("File write operation failed.");
   }
}

public class OutputTarget
{
   public bool SendToFile()
   {
      try
      {
         string fn = Path.GetTempFileName();
         StreamWriter sw = new StreamWriter(fn);
         sw.WriteLine("Hello, World!");
         sw.Close();
         return true;
      }  
      catch
      {
         return false;
      }
   }
}
Imports System.IO

Module TestDelegate
   Public Sub Main()
      Dim output As New OutputTarget()
      Dim methodCall As Func(Of Boolean) = Function() output.SendToFile()
      If methodCall() Then 
         Console.WriteLine("Success!")
      Else
         Console.WriteLine("File write operation failed.")
      End If      
   End Sub
End Module

Public Class OutputTarget
   Public Function SendToFile() As Boolean
      Try
         Dim fn As String = Path.GetTempFileName
         Dim sw As StreamWriter = New StreamWriter(fn)
         sw.WriteLine("Hello, World!")
         sw.Close      
         Return True
      Catch
         Return False
      End Try
   End Function
End Class

Le type sous-jacent d’une expression lambda est un des génériques Func délégués.The underlying type of a lambda expression is one of the generic Func delegates. Cela rend possible de passer d’une expression lambda en tant que paramètre sans lui assigner explicitement à un délégué.This makes it possible to pass a lambda expression as a parameter without explicitly assigning it to a delegate. En particulier, étant donné que de nombreuses méthodes des types dans le System.Linq espace de noms a Func paramètres, vous pouvez passer ces méthodes une expression lambda sans instancier explicitement un Func déléguer.In particular, because many methods of types in the System.Linq namespace have Func parameters, you can pass these methods a lambda expression without explicitly instantiating a Func delegate.

Si vous avez un calcul coûteux que vous souhaitez exécuter uniquement si le résultat est réellement nécessaire, vous pouvez affecter à la fonction coûteuse à un Func<TResult> déléguer.If you have an expensive computation that you want to execute only if the result is actually needed, you can assign the expensive function to a Func<TResult> delegate. L’exécution de la fonction peut alors être différée jusqu'à ce qu’une propriété qui accède à la valeur est utilisée dans une expression.The execution of the function can then be delayed until a property that accesses the value is used in an expression. L’exemple dans la section suivante montre comment effectuer cette opération.The example in the next section demonstrates how to do this.

S’applique à

Voir aussi