Func<TResult> Delegar

Definição

Encapsula um método que não tem parâmetros e retorna um valor do tipo especificado pelo parâmetro 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 

Parâmetros de tipo

TResult

O tipo do valor retornado do método encapsulado por esse delegado.The type of the return value of the method that this delegate encapsulates.

Valor Retornado

TResult

O valor retornado do método encapsulado por esse delegado.The return value of the method that this delegate encapsulates.

Herança
Func<TResult>

Exemplos

O exemplo a seguir demonstra como usar um delegado que não usa parâmetros.The following example demonstrates how to use a delegate that takes no parameters. Esse código cria uma classe genérica denominada LazyValue que tem um campo do tipo. Func<TResult>This code creates a generic class named LazyValue that has a field of type Func<TResult>. Esse campo delegado pode armazenar uma referência a qualquer função que retorna um valor do tipo que corresponde ao parâmetro de tipo do LazyValue objeto.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. O LazyValue tipo também tem uma Value propriedade que executa a função (se ela ainda não tiver sido executada) e retorna o valor resultante.The LazyValue type also has a Value property that executes the function (if it has not already been executed) and returns the resulting value.

O exemplo cria dois métodos e instancia dois LazyValue objetos com expressões lambda que chamam esses métodos.The example creates two methods and instantiates two LazyValue objects with lambda expressions that call these methods. As expressões lambda não usam parâmetros porque só precisam chamar um método.The lambda expressions do not take parameters because they just need to call a method. Como mostra a saída, os dois métodos são executados somente quando o valor de cada LazyValue objeto é recuperado.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

Comentários

Você pode usar esse delegado para representar um método que pode ser passado como um parâmetro sem declarar explicitamente um delegado personalizado.You can use this delegate to represent a method that can be passed as a parameter without explicitly declaring a custom delegate. O método encapsulado deve corresponder à assinatura do método que é definida por esse delegado.The encapsulated method must correspond to the method signature that is defined by this delegate. Isso significa que o método encapsulado não deve ter parâmetros e deve retornar um valor.This means that the encapsulated method must have no parameters and must return a value.

Observação

Para fazer referência a um método que não tem parâmetros void e retorna (ou em Visual Basic, que é declarado Sub como um e não Functioncomo um), Action use o delegado em vez disso.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.

Quando você usa o Func<TResult> delegado, não precisa definir explicitamente um delegado que encapsula um método sem parâmetros.When you use the Func<TResult> delegate, you do not have to explicitly define a delegate that encapsulates a parameterless method. Por exemplo, o código a seguir declara explicitamente um delegado chamado WriteMethod e atribui uma referência OutputTarget.SendToFile ao método de instância à sua instância delegada.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

O exemplo a seguir simplifica esse código ao instanciar o Func<TResult> delegado, em vez de definir explicitamente um novo delegado e atribuir um método nomeado a ele.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

Você pode usar o Func<TResult> delegado com métodos anônimos C#no, como ilustra o exemplo a seguir.You can use the Func<TResult> delegate with anonymous methods in C#, as the following example illustrates. (Para obter uma introdução aos métodos anônimos, consulte métodos anônimos.)(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;
      }
   }
}

Você também pode atribuir uma expressão lambda a um Func<T,TResult> delegado, como ilustra o exemplo a seguir.You can also assign a lambda expression to a Func<T,TResult> delegate, as the following example illustrates. (Para obter uma introdução a expressões lambda, consulte expressões lambda e expressões 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

O tipo subjacente de uma expressão lambda é um dos delegados genéricos Func .The underlying type of a lambda expression is one of the generic Func delegates. Isso torna possível passar uma expressão lambda como um parâmetro sem atribuí-la explicitamente a um delegado.This makes it possible to pass a lambda expression as a parameter without explicitly assigning it to a delegate. Em particular, como muitos métodos de tipos no System.Linq namespace têm Func parâmetros, você pode passar esses métodos a uma expressão lambda sem instanciar explicitamente um Func delegado.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.

Se você tiver uma computação cara que deseja executar somente se o resultado for realmente necessário, você poderá atribuir a função dispendiosa a um Func<TResult> delegado.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. A execução da função pode ser adiada até que uma propriedade que acesse o valor seja usada em uma expressão.The execution of the function can then be delayed until a property that accesses the value is used in an expression. O exemplo na próxima seção demonstra como fazer isso.The example in the next section demonstrates how to do this.

Métodos de Extensão

GetMethodInfo(Delegate)

Obtém um objeto que representa o método representado pelo delegado especificado.Gets an object that represents the method represented by the specified delegate.

Aplica-se a

Veja também