Export (0) Print
Expand All

MethodBuilder Class

Defines and represents a method (or constructor) on a dynamic class.

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

[ClassInterfaceAttribute(ClassInterfaceType::None)]
[ComVisibleAttribute(true)]
[HostProtectionAttribute(SecurityAction::LinkDemand, MayLeakOnAbort = true)]
public ref class MethodBuilder sealed : public MethodInfo, 
	_MethodBuilder

The MethodBuilder type exposes the following members.

  NameDescription
Public propertyAttributesRetrieves the attributes for this method. (Overrides MethodBase::Attributes.)
Public propertyCallingConventionReturns the calling convention of the method. (Overrides MethodBase::CallingConvention.)
Public propertyContainsGenericParametersNot supported for this type. (Overrides MethodBase::ContainsGenericParameters.)
Public propertyDeclaringTypeReturns the type that declares this method. (Overrides MemberInfo::DeclaringType.)
Public propertyInitLocalsGets or sets a Boolean value that specifies whether the local variables in this method are zero initialized. The default value of this property is true.
Public propertyIsAbstractGets a value indicating whether the method is abstract. (Inherited from MethodBase.)
Public propertyIsAssemblyGets a value indicating whether the potential visibility of this method or constructor is described by MethodAttributes::Assembly; that is, the method or constructor is visible at most to other types in the same assembly, and is not visible to derived types outside the assembly. (Inherited from MethodBase.)
Public propertyIsConstructorGets a value indicating whether the method is a constructor. (Inherited from MethodBase.)
Public propertyIsFamilyGets a value indicating whether the visibility of this method or constructor is described by MethodAttributes::Family; that is, the method or constructor is visible only within its class and derived classes. (Inherited from MethodBase.)
Public propertyIsFamilyAndAssemblyGets a value indicating whether the visibility of this method or constructor is described by MethodAttributes::FamANDAssem; that is, the method or constructor can be called by derived classes, but only if they are in the same assembly. (Inherited from MethodBase.)
Public propertyIsFamilyOrAssemblyGets a value indicating whether the potential visibility of this method or constructor is described by MethodAttributes::FamORAssem; that is, the method or constructor can be called by derived classes wherever they are, and by classes in the same assembly. (Inherited from MethodBase.)
Public propertyIsFinalGets a value indicating whether this method is final. (Inherited from MethodBase.)
Public propertyIsGenericMethodGets a value indicating whether the method is a generic method. (Overrides MethodBase::IsGenericMethod.)
Public propertyIsGenericMethodDefinitionGets a value indicating whether the current MethodBuilder object represents the definition of a generic method. (Overrides MethodBase::IsGenericMethodDefinition.)
Public propertyIsHideBySigGets a value indicating whether only a member of the same kind with exactly the same signature is hidden in the derived class. (Inherited from MethodBase.)
Public propertyIsPrivateGets a value indicating whether this member is private. (Inherited from MethodBase.)
Public propertyIsPublicGets a value indicating whether this is a public method. (Inherited from MethodBase.)
Public propertyIsSecurityCriticalThrows a NotSupportedException in all cases. (Overrides MethodBase::IsSecurityCritical.)
Public propertyIsSecuritySafeCriticalThrows a NotSupportedException in all cases. (Overrides MethodBase::IsSecuritySafeCritical.)
Public propertyIsSecurityTransparentThrows a NotSupportedException in all cases. (Overrides MethodBase::IsSecurityTransparent.)
Public propertyIsSpecialNameGets a value indicating whether this method has a special name. (Inherited from MethodBase.)
Public propertyIsStaticGets a value indicating whether the method is static. (Inherited from MethodBase.)
Public propertyIsVirtualGets a value indicating whether the method is virtual. (Inherited from MethodBase.)
Public propertyMemberTypeGets a MemberTypes value indicating that this member is a method. (Inherited from MethodInfo.)
Public propertyMetadataTokenGets a value that identifies a metadata element. (Inherited from MemberInfo.)
Public propertyMethodHandleRetrieves the internal handle for the method. Use this handle to access the underlying metadata handle. (Overrides MethodBase::MethodHandle.)
Public propertyModuleGets the module in which the current method is being defined. (Overrides MemberInfo::Module.)
Public propertyNameRetrieves the name of this method. (Overrides MemberInfo::Name.)
Public propertyReflectedTypeRetrieves the class that was used in reflection to obtain this object. (Overrides MemberInfo::ReflectedType.)
Public propertyReturnParameterGets a ParameterInfo object that contains information about the return type of the method, such as whether the return type has custom modifiers. (Overrides MethodInfo::ReturnParameter.)
Public propertyReturnTypeGets the return type of the method represented by this MethodBuilder. (Overrides MethodInfo::ReturnType.)
Public propertyReturnTypeCustomAttributesReturns the custom attributes of the method's return type. (Overrides MethodInfo::ReturnTypeCustomAttributes.)
Public propertySignatureRetrieves the signature of the method.
Top

  NameDescription
Public methodAddDeclarativeSecurityAdds declarative security to this method.
Public methodCreateMethodBodyCreates the body of the method using a supplied byte array of Microsoft intermediate language (MSIL) instructions.
Public methodDefineGenericParametersSets the number of generic type parameters for the current method, specifies their names, and returns an array of GenericTypeParameterBuilder objects that can be used to define their constraints.
Public methodDefineParameterSets the parameter attributes and the name of a parameter of this method, or of the return value of this method. Returns a ParameterBuilder that can be used to apply custom attributes.
Public methodEqualsDetermines whether the given object is equal to this instance. (Overrides MethodInfo::Equals(Object).)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetBaseDefinitionReturn the base implementation for a method. (Overrides MethodInfo::GetBaseDefinition().)
Public methodGetCustomAttributes(Boolean)Returns all the custom attributes defined for this method. (Overrides MemberInfo::GetCustomAttributes(Boolean).)
Public methodGetCustomAttributes(Type, Boolean)Returns the custom attributes identified by the given type. (Overrides MemberInfo::GetCustomAttributes(Type, Boolean).)
Public methodGetCustomAttributesDataReturns a list of CustomAttributeData objects representing data about the attributes that have been applied to the target member. (Inherited from MemberInfo.)
Public methodGetGenericArgumentsReturns an array of GenericTypeParameterBuilder objects that represent the type parameters of the method, if it is generic. (Overrides MethodInfo::GetGenericArguments().)
Public methodGetGenericMethodDefinitionReturns this method. (Overrides MethodInfo::GetGenericMethodDefinition().)
Public methodGetHashCodeGets the hash code for this method. (Overrides MethodInfo::GetHashCode().)
Public methodGetILGenerator()Returns an ILGenerator for this method with a default Microsoft intermediate language (MSIL) stream size of 64 bytes.
Public methodGetILGenerator(Int32)Returns an ILGenerator for this method with the specified Microsoft intermediate language (MSIL) stream size.
Public methodGetMethodBodyWhen overridden in a derived class, gets a MethodBody object that provides access to the MSIL stream, local variables, and exceptions for the current method. (Inherited from MethodBase.)
Public methodGetMethodImplementationFlagsReturns the implementation flags for the method. (Overrides MethodBase::GetMethodImplementationFlags().)
Public methodGetModuleReturns a reference to the module that contains this method.
Public methodGetParametersReturns the parameters of this method. (Overrides MethodBase::GetParameters().)
Public methodGetTokenReturns the MethodToken that represents the token for this method.
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodInvoke(Object, array<Object>)Invokes the method or constructor represented by the current instance, using the specified parameters. (Inherited from MethodBase.)
Public methodInvoke(Object, BindingFlags, Binder, array<Object>, CultureInfo)Dynamically invokes the method reflected by this instance on the given object, passing along the specified parameters, and under the constraints of the given binder. (Overrides MethodBase::Invoke(Object, BindingFlags, Binder, array<Object>, CultureInfo).)
Public methodIsDefinedChecks if the specified custom attribute type is defined. (Overrides MemberInfo::IsDefined(Type, Boolean).)
Public methodMakeGenericMethodReturns a generic method constructed from the current generic method definition using the specified generic type arguments. (Overrides MethodInfo::MakeGenericMethod(array<Type>).)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodSetCustomAttribute(CustomAttributeBuilder)Sets a custom attribute using a custom attribute builder.
Public methodSetCustomAttribute(ConstructorInfo, array<Byte>)Sets a custom attribute using a specified custom attribute blob.
Public methodSetImplementationFlagsSets the implementation flags for this method.
Public methodSetMarshal Obsolete. Sets marshaling information for the return type of this method.
Public methodSetParametersSets the number and types of parameters for a method.
Public methodSetReturnTypeSets the return type of the method.
Public methodSetSignatureSets the method signature, including the return type, the parameter types, and the required and optional custom modifiers of the return type and parameter types.
Public methodSetSymCustomAttributeSet a symbolic custom attribute using a blob.
Public methodToStringReturns this MethodBuilder instance as a string. (Overrides Object::ToString().)
Top

  NameDescription
Explicit interface implemetationPrivate method_MemberInfo::GetIDsOfNamesMaps a set of names to a corresponding set of dispatch identifiers. (Inherited from MemberInfo.)
Explicit interface implemetationPrivate method_MemberInfo::GetTypeGets a Type object representing the MemberInfo class. (Inherited from MemberInfo.)
Explicit interface implemetationPrivate method_MemberInfo::GetTypeInfoRetrieves the type information for an object, which can then be used to get the type information for an interface. (Inherited from MemberInfo.)
Explicit interface implemetationPrivate method_MemberInfo::GetTypeInfoCountRetrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from MemberInfo.)
Explicit interface implemetationPrivate method_MemberInfo::InvokeProvides access to properties and methods exposed by an object. (Inherited from MemberInfo.)
Explicit interface implemetationPrivate method_MethodBase::GetIDsOfNamesMaps a set of names to a corresponding set of dispatch identifiers. (Inherited from MethodBase.)
Explicit interface implemetationPrivate method_MethodBase::GetTypeFor a description of this member, see _MethodBase::GetType. (Inherited from MethodBase.)
Explicit interface implemetationPrivate method_MethodBase::GetTypeInfoRetrieves the type information for an object, which can then be used to get the type information for an interface. (Inherited from MethodBase.)
Explicit interface implemetationPrivate method_MethodBase::GetTypeInfoCountRetrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from MethodBase.)
Explicit interface implemetationPrivate method_MethodBase::InvokeProvides access to properties and methods exposed by an object. (Inherited from MethodBase.)
Explicit interface implemetationPrivate property_MethodBase::IsAbstractFor a description of this member, see _MethodBase::IsAbstract. (Inherited from MethodBase.)
Explicit interface implemetationPrivate property_MethodBase::IsAssemblyFor a description of this member, see _MethodBase::IsAssembly. (Inherited from MethodBase.)
Explicit interface implemetationPrivate property_MethodBase::IsConstructorFor a description of this member, see _MethodBase::IsConstructor. (Inherited from MethodBase.)
Explicit interface implemetationPrivate property_MethodBase::IsFamilyFor a description of this member, see _MethodBase::IsFamily. (Inherited from MethodBase.)
Explicit interface implemetationPrivate property_MethodBase::IsFamilyAndAssemblyFor a description of this member, see _MethodBase::IsFamilyAndAssembly. (Inherited from MethodBase.)
Explicit interface implemetationPrivate property_MethodBase::IsFamilyOrAssemblyFor a description of this member, see _MethodBase::IsFamilyOrAssembly. (Inherited from MethodBase.)
Explicit interface implemetationPrivate property_MethodBase::IsFinalFor a description of this member, see _MethodBase::IsFinal. (Inherited from MethodBase.)
Explicit interface implemetationPrivate property_MethodBase::IsHideBySigFor a description of this member, see _MethodBase::IsHideBySig. (Inherited from MethodBase.)
Explicit interface implemetationPrivate property_MethodBase::IsPrivateFor a description of this member, see _MethodBase::IsPrivate. (Inherited from MethodBase.)
Explicit interface implemetationPrivate property_MethodBase::IsPublicFor a description of this member, see _MethodBase::IsPublic. (Inherited from MethodBase.)
Explicit interface implemetationPrivate property_MethodBase::IsSpecialNameFor a description of this member, see _MethodBase::IsSpecialName. (Inherited from MethodBase.)
Explicit interface implemetationPrivate property_MethodBase::IsStaticFor a description of this member, see _MethodBase::IsStatic. (Inherited from MethodBase.)
Explicit interface implemetationPrivate property_MethodBase::IsVirtualFor a description of this member, see _MethodBase::IsVirtual. (Inherited from MethodBase.)
Explicit interface implemetationPrivate method_MethodBuilder::GetIDsOfNamesMaps a set of names to a corresponding set of dispatch identifiers.
Explicit interface implemetationPrivate method_MethodBuilder::GetTypeInfoRetrieves the type information for an object, which can then be used to get the type information for an interface.
Explicit interface implemetationPrivate method_MethodBuilder::GetTypeInfoCountRetrieves the number of type information interfaces that an object provides (either 0 or 1).
Explicit interface implemetationPrivate method_MethodBuilder::InvokeProvides access to properties and methods exposed by an object.
Explicit interface implemetationPrivate method_MethodInfo::GetIDsOfNamesMaps a set of names to a corresponding set of dispatch identifiers. (Inherited from MethodInfo.)
Explicit interface implemetationPrivate method_MethodInfo::GetTypeProvides access to the GetType method from COM. (Inherited from MethodInfo.)
Explicit interface implemetationPrivate method_MethodInfo::GetTypeInfoRetrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from MethodInfo.)
Explicit interface implemetationPrivate method_MethodInfo::GetTypeInfoCountRetrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from MethodInfo.)
Explicit interface implemetationPrivate method_MethodInfo::InvokeProvides access to properties and methods exposed by an object. (Inherited from MethodInfo.)
Top

MethodBuilder is used to fully describe a method in Microsoft intermediate language (MSIL), including the name, attributes, signature, and method body. It is used in conjunction with the TypeBuilder class to create classes at runtime.

NoteNote

The HostProtectionAttribute attribute applied to this type or member has the following Resources property value: MayLeakOnAbort. The HostProtectionAttribute does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the HostProtectionAttribute class or SQL Server Programming and Host Protection Attributes.

An example using the MethodBuilder class to create a method within a dynamic type is provided below.


using namespace System;
using namespace System::Reflection;
using namespace System::Reflection::Emit;

void AddMethodDynamically( TypeBuilder^ myTypeBld, 
                           String^ mthdName, 
                           array<Type^>^ mthdParams, 
                           Type^ returnType, 
                           String^ mthdAction )
{
   MethodBuilder^ myMthdBld = myTypeBld->DefineMethod( mthdName, static_cast<MethodAttributes>(MethodAttributes::Public | MethodAttributes::Static), returnType, mthdParams );
   ILGenerator^ ILOut = myMthdBld->GetILGenerator();
   int numParams = mthdParams->Length;
   for ( Byte x = 0; x < numParams; x++ )
   {
      ILOut->Emit( OpCodes::Ldarg_S, x );

   }
   if ( numParams > 1 )
   {
      for ( int y = 0; y < (numParams - 1); y++ )
      {
         if ( mthdAction->Equals( "A" ) )
                  ILOut->Emit( OpCodes::Add );
         else
         if ( mthdAction->Equals( "M" ) )
                  ILOut->Emit( OpCodes::Mul );
         else
                  ILOut->Emit( OpCodes::Add );

      }
   }

   ILOut->Emit( OpCodes::Ret );
};

void main()
{
   AppDomain^ myDomain = AppDomain::CurrentDomain;
   AssemblyName^ asmName = gcnew AssemblyName;
   asmName->Name = "MyDynamicAsm";
   AssemblyBuilder^ myAsmBuilder = myDomain->DefineDynamicAssembly( asmName, 
                                                                    AssemblyBuilderAccess::RunAndSave );
   ModuleBuilder^ myModule = myAsmBuilder->DefineDynamicModule( "MyDynamicAsm", 
                                                                "MyDynamicAsm.dll" );
   TypeBuilder^ myTypeBld = myModule->DefineType( "MyDynamicType", 
                                                  TypeAttributes::Public );

   // Get info from the user to build the method dynamically.
   Console::WriteLine( "Let's build a simple method dynamically!" );
   Console::WriteLine( "Please enter a few numbers, separated by spaces." );
   String^ inputNums = Console::ReadLine();
   Console::Write( "Do you want to [A]dd (default) or [M]ultiply these numbers? " );
   String^ myMthdAction = Console::ReadLine()->ToUpper();
   Console::Write( "Lastly, what do you want to name your new dynamic method? " );
   String^ myMthdName = Console::ReadLine();

   // Process inputNums into an array and create a corresponding Type array
   int index = 0;
   array<String^>^inputNumsList = inputNums->Split();
   array<Type^>^myMthdParams = gcnew array<Type^>(inputNumsList->Length);
   array<Object^>^inputValsList = gcnew array<Object^>(inputNumsList->Length);
   for each (String^ inputNum in inputNumsList)
   {
      inputValsList[ index ] = Convert::ToInt32( inputNum );
      myMthdParams[ index ] = int::typeid;
      index++;
   }


   // Now, call the method building method with the parameters, passing the
   // TypeBuilder by reference.
   AddMethodDynamically( myTypeBld, 
                         myMthdName, 
                         myMthdParams, 
                         int::typeid, 
                         myMthdAction );
   Type^ myType = myTypeBld->CreateType();

   Console::WriteLine( "---" );
   Console::WriteLine( "The result of {0} the inputted values is: {1}", 
                       ((myMthdAction->Equals( "M" )) ? "multiplying" : "adding"), 
                       myType->InvokeMember( myMthdName, 
                                             BindingFlags::InvokeMethod | BindingFlags::Public | BindingFlags::Static, 
                       nullptr, 
                       nullptr, 
                       inputValsList ) );
   Console::WriteLine( "---" );

   // Let's take a look at the method we created.
   // If you are interested in seeing the MSIL generated dynamically for the method
   // your program generated, change to the directory where you ran the compiled
   // code sample and type "ildasm MyDynamicAsm.dll" at the prompt. When the list
   // of manifest contents appears, click on "MyDynamicType" and then on the name of
   // of the method you provided during execution.

   myAsmBuilder->Save( "MyDynamicAsm.dll" );

   MethodInfo^ myMthdInfo = myType->GetMethod( myMthdName );
   Console::WriteLine( "Your Dynamic Method: {0};", myMthdInfo );
}



.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

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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Community Additions

ADD
Show:
© 2014 Microsoft