Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
LocalVariableInfo Class
Collapse the table of content
Expand the table of content

LocalVariableInfo Class

Discovers the attributes of a local variable and provides access to local variable metadata.

System.Object
  System.Reflection.LocalVariableInfo
    System.Reflection.Emit.LocalBuilder

Namespace:  System.Reflection
Assemblies:   mscorlib (in mscorlib.dll)
  System.Reflection (in System.Reflection.dll)

[ComVisibleAttribute(true)]
public class LocalVariableInfo

The LocalVariableInfo type exposes the following members.

  NameDescription
Protected methodLocalVariableInfoInitializes a new instance of the LocalVariableInfo class.
Top

  NameDescription
Public propertyIsPinnedGets a Boolean value that indicates whether the object referred to by the local variable is pinned in memory.
Public propertyLocalIndexGets the index of the local variable within the method body.
Public propertyLocalTypeGets the type of the local variable.
Top

  NameDescription
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from 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 methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a user-readable string that describes the local variable. (Overrides Object.ToString().)
Top

To get a list of local variables in a method, use the MethodBody.LocalVariables property. Use the MethodBase.GetMethodBody method to obtain the MethodBody for a MethodInfo object.

NoteNote

Local variable names are not persisted in metadata. In Microsoft intermediate language (MSIL), local variables are accessed by their position in the local variable signature.

The following example defines a test method named MethodBodyExample, and displays its local variable information. The GetMethodBody method is used to obtain a MethodBody object for the test method. The LocalVariables property is then used to obtain a list of LocalVariableInfo objects and to display their types and index order.

This code example is part of a larger example provided for the MethodBody class.

using System;
using System.Reflection;

public class Example
{
    public static void Main()
    {
        // Get method body information.
        MethodInfo mi = typeof(Example).GetMethod("MethodBodyExample");
        MethodBody mb = mi.GetMethodBody();
        Console.WriteLine("\r\nMethod: {0}", mi);

        // Display the general information included in the  
        // MethodBody object.
        Console.WriteLine("    Local variables are initialized: {0}", 
            mb.InitLocals);
        Console.WriteLine("    Maximum number of items on the operand stack: {0}", 
            mb.MaxStackSize);


...



// Display information about the local variables in the 
// method body.
Console.WriteLine();
foreach (LocalVariableInfo lvi in mb.LocalVariables)
{
    Console.WriteLine("Local variable: {0}", lvi);
}


...


    }

    // The Main method contains code to analyze this method, using 
    // the properties and methods of the MethodBody class. 
    public void MethodBodyExample(object arg)
    {
        // Define some local variables. In addition to these variables, 
        // the local variable list includes the variables scoped to  
        // the catch clauses. 
        int var1 = 42;
        string var2 = "Forty-two";

        try
        {
            // Depending on the input value, throw an ArgumentException or  
            // an ArgumentNullException to test the Catch clauses. 
            if (arg == null)
            {
                throw new ArgumentNullException("The argument cannot be null.");
            }
            if (arg.GetType() == typeof(string))
            {
                throw new ArgumentException("The argument cannot be a string.");
            }        
        }

        // There is no Filter clause in this code example. See the Visual  
        // Basic code for an example of a Filter clause. 

        // This catch clause handles the ArgumentException class, and 
        // any other class derived from Exception. 
        catch(Exception ex)
        {
            Console.WriteLine("Ordinary exception-handling clause caught: {0}", 
                ex.GetType());
        }        
        finally
        {
            var1 = 3033;
            var2 = "Another string.";
        }
    }
}

// This code example produces output similar to the following: 
// 
//Method: Void MethodBodyExample(System.Object) 
//    Local variables are initialized: True 
//    Maximum number of items on the operand stack: 2


...


// 
//Local variable: System.Int32 (0) 
//Local variable: System.String (1) 
//Local variable: System.Exception (2) 
//Local variable: System.Boolean (3)

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone Silverlight 8.1, Windows Phone Silverlight 8

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