LocalVariableInfo Class
Discovers the attributes of a local variable and provides access to local variable metadata.
Assembly: mscorlib (in mscorlib.dll)
The LocalVariableInfo type exposes the following members.
| Name | Description | |
|---|---|---|
![]() | IsPinned | Gets a Boolean value that indicates whether the object referred to by the local variable is pinned in memory. |
![]() | LocalIndex | Gets the index of the local variable within the method body. |
![]() | LocalType | Gets the type of the local variable. |
| Name | Description | |
|---|---|---|
![]() | Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
![]() | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
![]() | GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
![]() | ToString | Returns a user-readable string that describes the local variable. (Overrides Object.ToString.) |
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.
Note |
|---|
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.
Imports System Imports System.Reflection Public Class Example Public Shared Sub Main() ' Demonstrate the effect of the Visual Basic When keyword, which ' generates a Filter clause in the Try block. Dim e As New Example() Console.WriteLine() e.MethodBodyExample("String argument") e.MethodBodyExample(Nothing) ' Get method body information. Dim mi As MethodInfo = _ GetType(Example).GetMethod("MethodBodyExample") Dim mb As MethodBody = mi.GetMethodBody() Console.WriteLine(vbCrLf & "Method: {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() For Each lvi As LocalVariableInfo In mb.LocalVariables Console.WriteLine("Local variable: {0}", lvi) Next ... End Sub ' This test method is executed at the beginning of Main, to show ' how the Filter clause works. The Filter clause is generated by ' a Visual Basic When expression. If arg is Nothing, this method ' throws ArgumentNullException, which is caught by the filter ' clause. If arg is a string, the method throws ArgumentException, ' which does not match the filter clause. ' ' Sub Main also contains code to analyze this method, using ' the properties and methods of the MethodBody class. Public Sub MethodBodyExample(ByVal arg As Object) ' Define some local variables. In addition to these variables, ' the local variable list includes the variables scoped to ' the catch clauses. Dim var1 As Integer = 42 Dim var2 As String = "Forty-two" Try ' Depending on the input value, throw an ArgumentException or ' an ArgumentNullException to test the Catch clauses. ' If arg Is Nothing Then Throw New ArgumentNullException("The argument cannot be Nothing.") End If If arg.GetType() Is GetType(String) Then Throw New ArgumentException("The argument cannot be a string.") End If ' The When expression makes this a filter clause. The expression ' selects only exceptions that derive from the ArgumentException ' class. Other exceptions, including ArgumentException itself, ' are not handled by this filter clause. Catch ex As ArgumentException _ When ex.GetType().IsSubclassOf(GetType(ArgumentException)) Console.WriteLine("Filter clause caught: {0}", ex.GetType()) ' This catch clause handles the ArgumentException class, and ' any other class derived from Exception. Catch ex As Exception Console.WriteLine("Ordinary exception-handling clause caught: {0}", _ ex.GetType()) Finally var1 = 3033 var2 = "Another string." End Try End Sub End Class ' This code example produces output similar to the following: ' 'Ordinary exception-handling clause caught: System.ArgumentException 'Filter clause caught: System.ArgumentNullException ' 'Method: Void MethodBodyExample(System.Object) ' Local variables are initialized: True ' Maximum number of items on the operand stack: 3 ... ' 'Local variable: System.Int32 (0) 'Local variable: System.String (1) 'Local variable: System.ArgumentException (2) 'Local variable: System.Exception (3)
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.



Note