StackFrame Class

StackFrame Class

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

Provides information about a stack frame, which represents a function call on the call stack for the current thread.

System::Object
  System.Diagnostics::StackFrame

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

No code example is currently available or this language may not be supported.

The StackFrame type exposes the following members.

  NameDescription
Public methodStackFrame()Initializes a new instance of the StackFrame class.
Public methodStackFrame(Boolean)Security Critical. Initializes a new instance of the StackFrame class, and optionally captures source information.
Public methodStackFrame(Int32)Initializes a new instance of the StackFrame class that corresponds to a frame above the current stack frame.
Public methodStackFrame(Int32, Boolean)Security Critical. Initializes a new instance of the StackFrame class that corresponds to a frame above the current stack frame, and optionally captures source information.
Public methodStackFrame(String, Int32)Initializes a new instance of the StackFrame class that contains only the specified file name and line number.
Public methodStackFrame(String, Int32, Int32)Initializes a new instance of the StackFrame class that contains only the specified file name, line number, and column number.
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 the Object is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetFileColumnNumberGets the column number in the file that contains the code that is executing. This information is typically extracted from the debugging symbols for the executable.
Public methodGetFileLineNumberGets the line number in the file that contains the code that is executing. This information is typically extracted from the debugging symbols for the executable.
Public methodGetFileNameSecurity Critical. Gets the file name that contains the code that is executing. This information is typically extracted from the debugging symbols for the executable.
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetILOffsetGets the offset from the start of the Microsoft intermediate language (MSIL) code for the method that is executing. This offset might be an approximation depending on whether the just-in-time (JIT) compiler is generating debugging code. The generation of this debugging information is controlled by the DebuggableAttribute attribute.
Public methodGetMethodGets the method in which the frame is executing.
Public methodGetNativeOffsetGets the offset from the start of the native just-in-time (JIT) compiled code for the method that is being executed. The generation of this debugging information is controlled by the DebuggableAttribute class.
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringBuilds a readable representation of the stack frame. (Overrides Object::ToString().)
Top

  NameDescription
Public fieldStatic memberOFFSET_UNKNOWNDefines the value that is returned from the GetNativeOffset or GetILOffset method when the native or Microsoft intermediate language (MSIL) offset is unknown. This field is constant.
Top

A StackFrame object is created and pushed on the call stack for every function call that is made during the execution of a thread. The stack frame always includes MethodBase information, and optionally includes file name, line number, and column number information.

StackFrame information will be most informative with debug build configurations. By default, debug builds include debug symbols, but release builds do not. The debug symbols contain most of the file, method name, line number, and column information that is used in constructing StackFrame objects.

Version Notes

Windows Phone

 StackFrame is not supported in Windows Phone.

Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Windows Phone

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:
© 2017 Microsoft