StackFrame Класс
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Предоставляет сведения о вызове StackFrameфункции в стеке вызовов для текущего потока.
public ref class StackFrame sealedpublic ref class StackFramepublic sealed class StackFramepublic class StackFrame[System.Serializable]
public class StackFrame[System.Serializable]
[System.Runtime.InteropServices.ComVisible(true)]
public class StackFrametype StackFrame = class[<System.Serializable>]
type StackFrame = class[<System.Serializable>]
[<System.Runtime.InteropServices.ComVisible(true)>]
type StackFrame = classPublic NotInheritable Class StackFramePublic Class StackFrame- Наследование
-
StackFrame
- Атрибуты
Примеры
В следующем примере показано использование класса для предоставления сведений StackFrame о кадре стека для трассировки стека.
using System;
using System.Diagnostics;
namespace StackFrameExample
{
class Program
{
static void Main(string[] args)
{
try
{
Method1();
}
catch (Exception e)
{
StackTrace st = new StackTrace();
StackTrace st1 = new StackTrace(new StackFrame(true));
Console.WriteLine(" Stack trace for Main: {0}",
st1.ToString());
Console.WriteLine(st.ToString());
}
Console.WriteLine("Press Enter to exit.");
Console.ReadLine();
}
private static void Method1()
{
try
{
Method2(4);
}
catch (Exception e)
{
StackTrace st = new StackTrace();
StackTrace st1 = new StackTrace(new StackFrame(true));
Console.WriteLine(" Stack trace for Method1: {0}",
st1.ToString());
Console.WriteLine(st.ToString());
// Build a stack trace for the next frame.
StackTrace st2 = new StackTrace(new StackFrame(1, true));
Console.WriteLine(" Stack trace for next level frame: {0}",
st2.ToString());
throw e;
}
}
private static void Method2( int count)
{
try
{
if (count < 5)
throw new ArgumentException("count too large", "count");
}
catch (Exception e)
{
StackTrace st = new StackTrace();
StackTrace st1 = new StackTrace(new StackFrame(2,true));
Console.WriteLine(" Stack trace for Method2: {0}",
st1.ToString());
Console.WriteLine(st.ToString());
throw e;
}
}
}
}
Imports System.Diagnostics
Class Program
Shared Sub Main(ByVal args() As String)
Try
Method1()
Catch e As Exception
Dim st As New StackTrace()
Dim st1 As New StackTrace(New StackFrame(True))
Console.WriteLine(" Stack trace for Main: {0}", st1.ToString())
Console.WriteLine(st.ToString())
End Try
Console.WriteLine("Press Enter to exit.")
Console.ReadLine()
End Sub
Private Shared Sub Method1()
Try
Method2(4)
Catch e As Exception
Dim st As New StackTrace()
Dim st1 As New StackTrace(New StackFrame(True))
Console.WriteLine(" Stack trace for Method1: {0}", st1.ToString())
Console.WriteLine(st.ToString())
' Build a stack trace for the next frame.
Dim st2 As New StackTrace(New StackFrame(1, True))
Console.WriteLine(" Stack trace for next level frame: {0}", st2.ToString())
Throw e
End Try
End Sub
Private Shared Sub Method2(ByVal count As Integer)
Try
If count < 5 Then
Throw New ArgumentException("count too large", "count")
End If
Catch e As Exception
Dim st As New StackTrace()
Dim st1 As New StackTrace(New StackFrame(2, True))
Console.WriteLine(" Stack trace for Method2: {0}", st1.ToString())
Console.WriteLine(st.ToString())
Throw e
End Try
End Sub
End Class
В следующем примере показано использование элементов StackFrame класса.
using System;
using System.Diagnostics;
using SampleInternal;
namespace SamplePublic
{
// This console application illustrates various uses
// of the StackTrace and StackFrame classes.
class ConsoleApp
{
[STAThread]
static void Main()
{
ClassLevel1 mainClass = new ClassLevel1();
try {
mainClass.InternalMethod();
}
catch (Exception) {
Console.WriteLine(" Main method exception handler");
// Display file and line information, if available.
StackTrace st = new StackTrace(new StackFrame(true));
Console.WriteLine(" Stack trace for current level: {0}",
st.ToString());
Console.WriteLine(" File: {0}",
st.GetFrame(0).GetFileName());
Console.WriteLine(" Line Number: {0}",
st.GetFrame(0).GetFileLineNumber().ToString());
Console.WriteLine();
Console.WriteLine("-------------------------------------------------\n");
}
}
}
}
namespace SampleInternal
{
public class ClassLevel1
{
public void InternalMethod()
{
try
{
ClassLevel2 nestedClass = new ClassLevel2();
nestedClass.Level2Method();
}
catch (Exception e)
{
Console.WriteLine(" InternalMethod exception handler");
// Build a stack trace from one frame, skipping the
// current frame and using the next frame. By
// default, file and line information are not displayed.
StackTrace st = new StackTrace(new StackFrame(1));
Console.WriteLine(" Stack trace for next level frame: {0}",
st.ToString());
Console.WriteLine(" Stack frame for next level: ");
Console.WriteLine(" {0}", st.GetFrame(0).ToString());
Console.WriteLine(" Line Number: {0}",
st.GetFrame(0).GetFileLineNumber().ToString());
Console.WriteLine();
Console.WriteLine(" ... throwing exception to next level ...");
Console.WriteLine("-------------------------------------------------\n");
throw e;
}
}
}
public class ClassLevel2
{
public void Level2Method()
{
try
{
ClassLevel3 nestedClass = new ClassLevel3();
nestedClass.Level3Method();
}
catch (Exception e)
{
Console.WriteLine(" Level2Method exception handler");
// Display the full call stack at this level.
StackTrace st1 = new StackTrace(true);
Console.WriteLine(" Stack trace for this level: {0}",
st1.ToString());
// Build a stack trace from one frame, skipping the current
// frame and using the next frame.
StackTrace st2 = new StackTrace(new StackFrame(1, true));
Console.WriteLine(" Stack trace built with next level frame: {0}",
st2.ToString());
// Build a stack trace skipping the current frame, and
// including all the other frames.
StackTrace st3 = new StackTrace(1, true);
Console.WriteLine(" Stack trace built from the next level up: {0}",
st3.ToString());
Console.WriteLine();
Console.WriteLine(" ... throwing exception to next level ...");
Console.WriteLine("-------------------------------------------------\n");
throw e;
}
}
}
public class ClassLevel3
{
public void Level3Method()
{
try
{
ClassLevel4 nestedClass = new ClassLevel4();
nestedClass.Level4Method();
}
catch (Exception e)
{
Console.WriteLine(" Level3Method exception handler");
// Build a stack trace from a dummy stack frame.
// Explicitly specify the source file name and
// line number.
StackTrace st = new StackTrace(new StackFrame("source.cs", 60));
Console.WriteLine(" Stack trace with dummy stack frame: {0}",
st.ToString());
for(int i =0; i< st.FrameCount; i++ )
{
// Display the stack frame properties.
StackFrame sf = st.GetFrame(i);
Console.WriteLine(" File: {0}", sf.GetFileName());
Console.WriteLine(" Line Number: {0}",
sf.GetFileLineNumber());
// Note that the column number defaults to zero
// when not initialized.
Console.WriteLine(" Column Number: {0}",
sf.GetFileColumnNumber());
if (sf.GetILOffset() != StackFrame.OFFSET_UNKNOWN)
{
Console.WriteLine(" Intermediate Language Offset: {0}",
sf.GetILOffset());
}
if (sf.GetNativeOffset() != StackFrame.OFFSET_UNKNOWN)
{
Console.WriteLine(" Native Offset: {0}",
sf.GetNativeOffset());
}
}
Console.WriteLine();
Console.WriteLine(" ... throwing exception to next level ...");
Console.WriteLine("-------------------------------------------------\n");
throw e;
}
}
}
public class ClassLevel4
{
public void Level4Method()
{
try
{
ClassLevel5 nestedClass = new ClassLevel5();
nestedClass.Level5Method();
}
catch (Exception e)
{
Console.WriteLine(" Level4Method exception handler");
// Build a stack trace from a dummy stack frame.
// Explicitly specify the source file name, line number
// and column number.
StackTrace st = new StackTrace(new StackFrame("source.cs", 79, 24));
Console.WriteLine(" Stack trace with dummy stack frame: {0}",
st.ToString());
// Access the StackFrames explicitly to display the file
// name, line number and column number properties.
// StackTrace.ToString only includes the method name.
for(int i =0; i< st.FrameCount; i++ )
{
StackFrame sf = st.GetFrame(i);
Console.WriteLine(" File: {0}", sf.GetFileName());
Console.WriteLine(" Line Number: {0}",
sf.GetFileLineNumber());
Console.WriteLine(" Column Number: {0}",
sf.GetFileColumnNumber());
}
Console.WriteLine();
Console.WriteLine(" ... throwing exception to next level ...");
Console.WriteLine("-------------------------------------------------\n");
throw e;
}
}
}
public class ClassLevel5
{
public void Level5Method()
{
try
{
ClassLevel6 nestedClass = new ClassLevel6();
nestedClass.Level6Method();
}
catch (Exception e)
{
Console.WriteLine(" Level5Method exception handler");
StackTrace st = new StackTrace();
// Display the most recent function call.
StackFrame sf = st.GetFrame(0);
Console.WriteLine();
Console.WriteLine(" Exception in method: ");
Console.WriteLine(" {0}", sf.GetMethod());
if (st.FrameCount >1)
{
// Display the highest-level function call
// in the trace.
sf = st.GetFrame(st.FrameCount-1);
Console.WriteLine(" Original function call at top of call stack):");
Console.WriteLine(" {0}", sf.GetMethod());
}
Console.WriteLine();
Console.WriteLine(" ... throwing exception to next level ...");
Console.WriteLine("-------------------------------------------------\n");
throw e;
}
}
}
public class ClassLevel6
{
public void Level6Method()
{
throw new Exception("An error occurred in the lowest internal class method.");
}
}
}
Imports System.Diagnostics
Imports SampleInternal
Namespace SamplePublic
' This console application illustrates various uses
' of the StackTrace and StackFrame classes.
Class ConsoleApp
<STAThread()> _
Shared Sub Main()
Dim mainClass As New ClassLevel1
Try
mainClass.InternalMethod()
Catch
Console.WriteLine(" Main method exception handler")
' Display file and line information, if available.
Dim st As New StackTrace(New StackFrame(True))
Console.WriteLine(" Stack trace for current level: {0}", _
st.ToString())
Console.WriteLine(" File: {0}", _
st.GetFrame(0).GetFileName())
Console.WriteLine(" Line Number: {0}", _
st.GetFrame(0).GetFileLineNumber().ToString())
Console.WriteLine()
Console.WriteLine("-------------------------------------------------")
Console.WriteLine()
End Try
End Sub
End Class
End Namespace 'StackFramePublic
Namespace SampleInternal
Public Class ClassLevel1
Public Sub InternalMethod()
Try
Dim nestedClass As New ClassLevel2
nestedClass.Level2Method()
Catch e As Exception
Console.WriteLine(" InternalMethod exception handler")
' Build a stack trace from one frame, skipping the
' current frame and using the next frame. By default,
' file and line information are not displayed.
Dim st As New StackTrace(New StackFrame(1))
Console.WriteLine(" Stack trace for next level frame: {0}", _
st.ToString())
Console.WriteLine(" Stack frame for next level: ")
Console.WriteLine(" {0}", st.GetFrame(0).ToString())
Console.WriteLine(" Line Number: {0}", _
st.GetFrame(0).GetFileLineNumber().ToString())
Console.WriteLine()
Console.WriteLine(" ... throwing exception to next level ...")
Console.WriteLine("-------------------------------------------------")
Console.WriteLine()
Throw e
End Try
End Sub
End Class
Public Class ClassLevel2
Public Sub Level2Method()
Try
Dim nestedClass As New ClassLevel3
nestedClass.Level3Method()
Catch e As Exception
Console.WriteLine(" Level2Method exception handler")
' Display the full call stack at this level.
Dim st1 As New StackTrace(True)
Console.WriteLine(" Stack trace for this level: {0}", _
st1.ToString())
' Build a stack trace from one frame, skipping the current
' frame and using the next frame.
Dim st2 As New StackTrace(New StackFrame(1, True))
Console.WriteLine(" Stack trace built with next level frame: {0}", _
st2.ToString())
' Build a stack trace skipping the current frame, and
' including all the other frames.
Dim st3 As New StackTrace(1, True)
Console.WriteLine(" Stack trace built from the next level up: {0}", _
st3.ToString())
Console.WriteLine()
Console.WriteLine(" ... throwing exception to next level ...")
Console.WriteLine("-------------------------------------------------")
Console.WriteLine()
Throw e
End Try
End Sub
End Class
Public Class ClassLevel3
Public Sub Level3Method()
Try
Dim nestedClass As New ClassLevel4()
nestedClass.Level4Method()
Catch e As Exception
Console.WriteLine(" Level3Method exception handler")
' Build a stack trace from a dummy stack frame.
' Explicitly specify the source file name and line number.
Dim st As New StackTrace(New StackFrame("source.cs", 60))
Console.WriteLine(" Stack trace with dummy stack frame: {0}", _
st.ToString())
Dim i As Integer
For i = 0 To st.FrameCount - 1
' Display the stack frame properties.
Dim sf As StackFrame = st.GetFrame(i)
Console.WriteLine(" File: {0}", sf.GetFileName())
Console.WriteLine(" Line Number: {0}", _
sf.GetFileLineNumber())
' The column number defaults to zero when not initialized.
Console.WriteLine(" Column Number: {0}", _
sf.GetFileColumnNumber())
If sf.GetILOffset <> StackFrame.OFFSET_UNKNOWN
Console.WriteLine(" Intermediate Language Offset: {0}", _
sf.GetILOffset())
End If
If sf.GetNativeOffset <> StackFrame.OFFSET_UNKNOWN
Console.WriteLine(" Native Offset: {0}", _
sf.GetNativeOffset())
End If
Next i
Console.WriteLine()
Console.WriteLine(" ... throwing exception to next level ...")
Console.WriteLine("-------------------------------------------------")
Console.WriteLine()
Throw e
End Try
End Sub
End Class
Public Class ClassLevel4
Public Sub Level4Method()
Try
Dim [nestedClass] As New ClassLevel5()
[nestedClass].Level5Method()
Catch e As Exception
Console.WriteLine(" Level4Method exception handler")
' Build a stack trace from a dummy stack frame.
' Explicitly specify the source file name, line number
' and column number.
Dim st As New StackTrace(New StackFrame("source.cs", 79, 24))
Console.WriteLine(" Stack trace with dummy stack frame: {0}", _
st.ToString())
' Access the StackFrames explicitly to display the file
' name, line number and column number properties.
' StackTrace.ToString only includes the method name.
Dim i As Integer
For i = 0 To st.FrameCount - 1
Dim sf As StackFrame = st.GetFrame(i)
Console.WriteLine(" File: {0}", sf.GetFileName())
Console.WriteLine(" Line Number: {0}", _
sf.GetFileLineNumber())
Console.WriteLine(" Column Number: {0}", _
sf.GetFileColumnNumber())
Next i
Console.WriteLine()
Console.WriteLine(" ... throwing exception to next level ...")
Console.WriteLine("-------------------------------------------------")
Console.WriteLine()
Throw e
End Try
End Sub
End Class
Public Class ClassLevel5
Public Sub Level5Method()
Try
Dim nestedClass As New ClassLevel6()
nestedClass.Level6Method()
Catch e As Exception
Console.WriteLine(" Level5Method exception handler")
Dim st As New StackTrace()
' Display the most recent function call.
Dim sf As StackFrame = st.GetFrame(0)
Console.WriteLine()
Console.WriteLine(" Exception in method: ")
Console.WriteLine(" {0}", sf.GetMethod())
If st.FrameCount > 1 Then
' Display the highest-level function call in the trace.
sf = st.GetFrame((st.FrameCount - 1))
Console.WriteLine(" Original function call at top of call stack):")
Console.WriteLine(" {0}", sf.GetMethod())
End If
Console.WriteLine()
Console.WriteLine(" ... throwing exception to next level ...")
Console.WriteLine("-------------------------------------------------")
Console.WriteLine()
Throw e
End Try
End Sub
End Class
Public Class ClassLevel6
Public Sub Level6Method()
Throw New Exception("An error occurred in the lowest internal class method.")
End Sub
End Class
End Namespace 'StackFrameInternal
Комментарии
Создается StackFrame и отправляется в стек вызовов для каждого вызова функции, сделанного во время выполнения потока. Кадр стека всегда включает MethodBase сведения, а также имя файла, номер строки и число столбцов.
StackFrame сведения будут наиболее информативными с конфигурациями сборки отладки. По умолчанию сборки отладки включают символы отладки, а сборки выпуска не выполняются. Символы отладки содержат большую часть файла, имени метода, номера строки и столбца, используемых в создании StackFrame объектов.
Конструкторы
| Имя | Описание |
|---|---|
| StackFrame() |
Инициализирует новый экземпляр класса StackFrame. |
| StackFrame(Boolean) |
Инициализирует новый экземпляр StackFrame класса, при необходимости захватывая исходные сведения. |
| StackFrame(Int32, Boolean) |
Инициализирует новый экземпляр StackFrame класса, соответствующий кадру над текущим кадром стека, при необходимости захватывая исходные сведения. |
| StackFrame(Int32) |
Инициализирует новый экземпляр StackFrame класса, соответствующий кадру над текущим кадром стека. |
| StackFrame(String, Int32, Int32) |
Инициализирует новый экземпляр StackFrame класса, который содержит только заданное имя файла, номер строки и номер столбца. |
| StackFrame(String, Int32) |
Инициализирует новый экземпляр StackFrame класса, который содержит только заданное имя файла и номер строки. |
Поля
| Имя | Описание |
|---|---|
| OFFSET_UNKNOWN |
Определяет значение, возвращаемое из метода GetNativeOffset() или GetILOffset(), если смещение собственного или Microsoft промежуточного языка (MSIL) неизвестно. Это поле является константой. |
Методы
| Имя | Описание |
|---|---|
| Equals(Object) |
Определяет, равен ли указанный объект текущему объекту. (Унаследовано от Object) |
| GetFileColumnNumber() |
Возвращает номер столбца в файле, который содержит выполняемый код. Обычно эти сведения извлекаются из символов отладки для исполняемого файла. |
| GetFileLineNumber() |
Возвращает номер строки в файле, который содержит выполняемый код. Обычно эти сведения извлекаются из символов отладки для исполняемого файла. |
| GetFileName() |
Возвращает имя файла, содержащего выполняемый код. Обычно эти сведения извлекаются из символов отладки для исполняемого файла. |
| GetHashCode() |
Служит хэш-функцией по умолчанию. (Унаследовано от Object) |
| GetILOffset() |
Получает смещение от начала кода Microsoft промежуточного языка (MSIL) для выполняемого метода. Это смещение может быть приближением в зависимости от того, создает ли JIT-компилятор JIT-код. Создание этой информации отладки управляется с помощью DebuggableAttribute. |
| GetMethod() |
Получает метод, в котором выполняется кадр. |
| GetNativeOffset() |
Получает смещение от начала собственного JIT-скомпилированного кода для выполняемого метода. Создание этой информации отладки контролируется классом DebuggableAttribute . |
| GetType() |
Возвращает Type текущего экземпляра. (Унаследовано от Object) |
| MemberwiseClone() |
Создает неглубокую копию текущей Object. (Унаследовано от Object) |
| ToString() |
Создает доступное для чтения представление трассировки стека. |
Методы расширения
| Имя | Описание |
|---|---|
| GetNativeImageBase(StackFrame) |
Возвращает указатель на базовый адрес собственного изображения, выполняемого этим кадром стека. |
| GetNativeIP(StackFrame) |
Возвращает указатель интерфейса на начало машинного кода для выполняемого метода. |
| HasILOffset(StackFrame) |
Указывает, доступно ли смещение от начала кода IL для выполняемого метода. |
| HasMethod(StackFrame) |
Указывает, доступна ли информация о методе, в котором выполняется указанный кадр. |
| HasNativeImage(StackFrame) |
Указывает, доступен ли собственный образ для указанного кадра стека. |
| HasSource(StackFrame) |
Указывает, доступен ли файл, содержащий код, который выполняет указанный кадр стека. |
