1 out of 2 rated this helpful - Rate this topic

MethodBase.Invoke Method (Object, Object[])

Updated: October 2010

Invokes the method or constructor represented by the current instance, using the specified parameters.

Namespace:  System.Reflection
Assembly:  mscorlib (in mscorlib.dll)
public Object Invoke(
	Object obj,
	Object[] parameters
)

Parameters

obj
Type: System.Object
The object on which to invoke the method or constructor. If a method is static, this argument is ignored. If a constructor is static, this argument must be null or an instance of the class that defines the constructor.
parameters
Type: System.Object[]
An argument list for the invoked method or constructor. This is an array of objects with the same number, order, and type as the parameters of the method or constructor to be invoked. If there are no parameters, parameters should be null.
If the method or constructor represented by this instance takes a ref parameter (ByRef in Visual Basic), no special attribute is required for that parameter in order to invoke the method or constructor using this function. Any object in this array that is not explicitly initialized with a value will contain the default value for that object type. For reference-type elements, this value is null. For value-type elements, this value is 0, 0.0, or false, depending on the specific element type.

Return Value

Type: System.Object
An object containing the return value of the invoked method, or null in the case of a constructor.
Caution noteCaution

Elements of the parameters array that represent parameters declared with the ref or out keyword may also be modified.

Implements

_MethodBase.Invoke(Object, Object[])
Exception Condition
TargetException

The obj parameter is null and the method is not static.

-or-

The method is not declared or inherited by the class of obj.

-or-

A static constructor is invoked, and obj is neither null nor an instance of the class that declared the constructor.

ArgumentException

The elements of the parameters array do not match the signature of the method or constructor reflected by this instance.

TargetInvocationException

The invoked method or constructor throws an exception.

-or-

The current instance is a DynamicMethod that contains unverifiable code. See the "Verification" section in Remarks for DynamicMethod.

TargetParameterCountException

The parameters array does not have the correct number of arguments.

MethodAccessException

The caller does not have permission to execute the constructor.

InvalidOperationException

The type that declares the method is an open generic type. That is, the Type.ContainsGenericParameters property returns true for the declaring type.

NotSupportedException

The current instance is a MethodBuilder.

This is a convenience method that calls the Invoke(Object, BindingFlags, Binder, Object[], CultureInfo) method overload, passing Default for invokeAttr and null for binder and culture.

If the invoked method throws an exception, the Exception.GetBaseException method returns the exception.

To invoke a static method using its MethodInfo object, pass null for obj.

Note Note

If this method overload is used to invoke an instance constructor, the object supplied for obj is reinitialized; that is, all instance initializers are executed. The return value is null. If a class constructor is invoked, the class is reinitialized; that is, all class initializers are executed. The return value is null.

Note Note

Starting with the .NET Framework version 2.0 Service Pack 1, this method can be used to access non-public members if the caller has been granted ReflectionPermission with the ReflectionPermissionFlag.RestrictedMemberAccess flag and if the grant set of the non-public members is restricted to the caller’s grant set, or a subset thereof. (See Security Considerations for Reflection.)

To use this functionality, your application should target the .NET Framework version 3.5 or later.

If a parameter of the current method is a value type, and the corresponding argument in parameters is null, the runtime passes a zero-initialized instance of the value type.

The following code example demonstrates dynamic method lookup using reflection. Note that you cannot use the MethodInfo object from the base class to invoke the overridden method in the derived class, because late binding cannot resolve overrides.


using System;
using System.Reflection;

public class MagicClass
{
    private int magicBaseValue;

    public MagicClass()
    {
        magicBaseValue = 9;
    }

    public int ItsMagic(int preMagic)
    {
        return preMagic * magicBaseValue;
    }
}

public class TestMethodInfo
{
    public static void Main()
    {
        // Get the constructor and create an instance of MagicClass

        Type magicType = Type.GetType("MagicClass");
        ConstructorInfo magicConstructor = magicType.GetConstructor(Type.EmptyTypes);
        object magicClassObject = magicConstructor.Invoke(new object[]{});

        // Get the ItsMagic method and invoke with a parameter value of 100

        MethodInfo magicMethod = magicType.GetMethod("ItsMagic");
        object magicValue = magicMethod.Invoke(magicClassObject, new object[]{100});

        Console.WriteLine("MethodInfo.Invoke() Example\n");
        Console.WriteLine("MagicClass.ItsMagic() returned: {0}", magicValue);
    }
}

// The example program gives the following output:
//
// MethodInfo.Invoke() Example
//
// MagicClass.ItsMagic() returned: 900


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Date

History

Reason

October 2010

Added caveat regarding ref and out parameters.

Customer feedback.

Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ
Multiple parameters
I just thought I would add this as I wanted to find this out.

If the ItsMagic method had multiple parameters like this:

public int ItsMagic(int preMagic, int morePreMagic)
{
    return (preMagic + morePreMagic) * magicBaseValue;
}

then do the following:

object magicValue = magicMethod.Invoke(magicClassObject, new object[] { 100, 900});

the result will be 9000.
Invoking methods with "out"/"byRef" parameters
To invoke a method with "out" parameters, make sure to create the object array outside of the Invoke method and pass null value to all out parameters. $0$0 $0 $0After the Invoke, read the parameters array for the returned values.$0
Very tricky
As is, I get an unhandled NullReferenceException running this sample in c#.  2010/client 4.  It would be great to have a sample that worked.  This is tricky stuff.

ConstructorInfo magicConstructor = magicType.GetConstructor(new Type[] {});

  seems to fix for me.