Func<TResult> 代理人

定義

パラメーターを受け取らずに、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 

型パラメーター

TResult

このデリゲートによってカプセル化されるメソッドの戻り値の型。The type of the return value of the method that this delegate encapsulates.

戻り値

TResult

このデリゲートによってカプセル化されるメソッドの戻り値。The return value of the method that this delegate encapsulates.

継承
Func<TResult>

次の例は、パラメーターを受け取らないデリゲートを使用する方法を示しています。The following example demonstrates how to use a delegate that takes no parameters. このコードは、型LazyValue Func<TResult>のフィールドを持つという名前のジェネリッククラスを作成します。This code creates a generic class named LazyValue that has a field of type Func<TResult>. このデリゲートフィールドには、 LazyValueオブジェクトの型パラメーターに対応する型の値を返す関数への参照を格納できます。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. LazyValueValueは、(まだ実行されていない場合は) 関数を実行し、結果の値を返すプロパティもあります。The LazyValue type also has a Value property that executes the function (if it has not already been executed) and returns the resulting value.

この例では、2つのLazyValueメソッドを作成し、これらのメソッドを呼び出すラムダ式を使用して2つのオブジェクトをインスタンス化します。The example creates two methods and instantiates two LazyValue objects with lambda expressions that call these methods. ラムダ式は、メソッドを呼び出す必要があるだけなので、パラメーターを受け取りません。The lambda expressions do not take parameters because they just need to call a method. 出力に示されているように、各LazyValueオブジェクトの値が取得された場合にのみ、2つのメソッドが実行されます。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

注釈

このデリゲートを使用すると、カスタムデリゲートを明示的に宣言しなくてもパラメーターとして渡すことができるメソッドを表すことができます。You can use this delegate to represent a method that can be passed as a parameter without explicitly declaring a custom delegate. カプセル化されたメソッドは、このデリゲートで定義されているメソッドシグネチャに対応している必要があります。The encapsulated method must correspond to the method signature that is defined by this delegate. これは、カプセル化されたメソッドにはパラメーターがなく、値を返す必要があることを意味します。This means that the encapsulated method must have no parameters and must return a value.

注意

パラメーターを持たずvoid 、を返す (または Visual Basic ではなくとSubしてFunction宣言されている) メソッドを参照するにActionは、代わりにデリゲートを使用します。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.

Func<TResult>デリゲートを使用する場合は、パラメーターなしのメソッドをカプセル化するデリゲートを明示的に定義する必要はありません。When you use the Func<TResult> delegate, you do not have to explicitly define a delegate that encapsulates a parameterless method. たとえば、次のコードでは、という名前WriteMethodのデリゲートを明示的にOutputTarget.SendToFile宣言し、インスタンスメソッドへの参照をそのデリゲートインスタンスに割り当てます。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

次の例では、新しいデリゲートをFunc<TResult>明示的に定義し、名前付きメソッドを割り当てるのではなく、デリゲートをインスタンス化することによって、このコードを簡略化します。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

次の例にFunc<TResult>示すようにC#、の匿名メソッドでデリゲートを使用できます。You can use the Func<TResult> delegate with anonymous methods in C#, as the following example illustrates. (匿名メソッドの概要については、「匿名メソッド」を参照してください)。(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;
      }
   }
}

次の例に示すように、ラムダFunc<T,TResult>式をデリゲートに割り当てることもできます。You can also assign a lambda expression to a Func<T,TResult> delegate, as the following example illustrates. (ラムダ式の概要については、「ラムダ式」と「ラムダ式」を参照してください)。(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

ラムダ式の基になる型は、汎用Funcデリゲートの1つです。The underlying type of a lambda expression is one of the generic Func delegates. これにより、ラムダ式をデリゲートに明示的に代入せずに、パラメーターとして渡すことができます。This makes it possible to pass a lambda expression as a parameter without explicitly assigning it to a delegate. 特に、 System.Linq名前空間の型の多くのメソッドにFuncパラメーターがあるため、デリゲートをFunc明示的にインスタンス化せずにこれらのメソッドをラムダ式に渡すことができます。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.

結果が実際に必要な場合にのみ実行する負荷の高い計算がある場合は、負荷の高い関数をFunc<TResult>デリゲートに割り当てることができます。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. その後、値にアクセスするプロパティが式で使用されるまで、関数の実行を遅延させることができます。The execution of the function can then be delayed until a property that accesses the value is used in an expression. 次のセクションの例では、これを行う方法を示します。The example in the next section demonstrates how to do this.

拡張メソッド

GetMethodInfo(Delegate)

指定したデリゲートによって表されるメソッドを表すオブジェクトを取得します。Gets an object that represents the method represented by the specified delegate.

適用対象

こちらもご覧ください