Func(Of T1, T2, T3, TResult) Delegate

 

Encapsulates a method that has three parameters and returns a value of the type specified by the TResult parameter.

Namespace:   System
Assembly:  mscorlib (in mscorlib.dll)

Public Delegate Function Func(Of In T1, In T2, In T3, Out TResult) (
	arg1 As T1,
	arg2 As T2,
	arg3 As T3
) As TResult

Parameters

arg1
Type: T1

The first parameter of the method that this delegate encapsulates.

arg2
Type: T2

The second parameter of the method that this delegate encapsulates.

arg3
Type: T3

The third parameter of the method that this delegate encapsulates.

Return Value

Type: TResult

The return value of the method that this delegate encapsulates.

Type Parameters

InT1

The type of the first parameter of the method that this delegate encapsulates.

InT2

The type of the second parameter of the method that this delegate encapsulates.

InT3

The type of the third parameter of the method that this delegate encapsulates.

OutTResult

The type of the return value of the method that this delegate encapsulates.

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 three parameters, each of which is passed to it by value, and that it must return a value.

System_CAPS_noteNote

To reference a method that has three parameters and returns void (or in Visual Basic, that is declared as a Sub rather than as a Function), use the generic Action(Of T1, T2, T3) delegate instead.

When you use the Func(Of T1, T2, T3, TResult) delegate, you do not have to explicitly define a delegate that encapsulates a method with three parameters. For example, the following code explicitly declares a generic delegate named ParseNumber and assigns a reference to the Parse method to its delegate instance.

Imports System.Globalization

Delegate Function ParseNumber(Of T)(input As String, styles As NumberStyles, _
                                    provider As IFormatProvider) As T

Module DelegateExample
   Public Sub Main()
      Dim numericString As String = "-1,234"
      Dim parser As ParseNumber(Of Integer) = AddressOf Integer.Parse
      Console.WriteLine(parser(numericString, _
                        NumberStyles.Integer Or NumberStyles.AllowThousands, _
                        CultureInfo.InvariantCulture))
   End Sub
End Module

The following example simplifies this code by instantiating the Func(Of T1, T2, T3, TResult) delegate instead of explicitly defining a new delegate and assigning a named method to it.

Imports System.Globalization

Module GenericFunc
   Public Sub Main()
      Dim numericString As String = "-1,234"
      Dim parser As Func(Of String, NumberStyles, IFormatProvider, Integer) _
                         = AddressOf Integer.Parse
      Console.WriteLine(parser(numericString, _
                        NumberStyles.Integer Or NumberStyles.AllowThousands, _
                        CultureInfo.InvariantCulture))
   End Sub
End Module

You can use the Func(Of T1, T2, T3, TResult) delegate with anonymous methods in C#, as the following example illustrates. (For an introduction to anonymous methods, see Anonymous Methods (C# Programming Guide).)

using System;
using System.Globalization;

public class Anonymous
{
   public static void Main()
   {
      string numericString = "-1,234";
      Func<string, NumberStyles, IFormatProvider, int> parser = 
           delegate(string s, NumberStyles sty, IFormatProvider p) 
           { return int.Parse(s, sty, p); };
      Console.WriteLine(parser(numericString, 
                        NumberStyles.Integer | NumberStyles.AllowThousands, 
                        CultureInfo.InvariantCulture));
   }
}

You can also assign a lambda expression to a Func(Of T1, T2, T3, TResult) delegate, as the following example illustrates. (For an introduction to lambda expressions, see Lambda Expressions (Visual Basic) and Lambda Expressions (C# Programming Guide).)

Imports System.Globalization

Module LambdaExpression
   Public Sub Main()
      Dim numericString As String = "-1,234"
      Dim parser As Func(Of String, NumberStyles, IFormatProvider, Integer) _
                         = Function(s, sty, p) Integer.Parse(s, sty, p)
      Console.WriteLine(parser(numericString, _
                        NumberStyles.Integer Or NumberStyles.AllowThousands, _
                        CultureInfo.InvariantCulture))
   End Sub
End Module

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

The following example demonstrates how to declare and use a Func(Of T1, T2, TResult) delegate. This example declares a Func(Of T1, T2, TResult) variable and assigns it a lambda expression that takes a String value and an Int32 value as parameters. The lambda expression returns true if the length of the String parameter is equal to the value of the Int32 parameter. The delegate that encapsulates this method is subsequently used in a query to filter strings in an array of strings.

Imports System.Collections.Generic
Imports System.Linq

Public Module Func3Example

   Public Sub Main()
      Dim predicate As Func(Of String, Integer, Boolean) = Function(str, index) str.Length = index

      Dim words() As String = { "orange", "apple", "Article", "elephant", "star", "and" }
      Dim aWords As IEnumerable(Of String) = words.Where(predicate)

      For Each word As String In aWords
         Console.WriteLine(word)
      Next   
   End Sub
End Module

Universal Windows Platform
Available since 8
.NET Framework
Available since 3.5
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1
Return to top
Show: