StackFrame Classe
Definição
Importante
Algumas informações dizem respeito a um produto pré-lançado que pode ser substancialmente modificado antes de ser lançado. A Microsoft não faz garantias, de forma expressa ou implícita, em relação à informação aqui apresentada.
Fornece informação sobre um StackFrame, que representa uma chamada de função na pilha de chamadas para a thread atual.
public ref class StackFrame sealed
public ref class StackFrame
public sealed class StackFrame
[System.Serializable]
public class StackFrame
[System.Serializable]
[System.Runtime.InteropServices.ComVisible(true)]
public class StackFrame
public class StackFrame
type StackFrame = class
[<System.Serializable>]
type StackFrame = class
[<System.Serializable>]
[<System.Runtime.InteropServices.ComVisible(true)>]
type StackFrame = class
Public NotInheritable Class StackFrame
Public Class StackFrame
- Herança
-
StackFrame
- Atributos
Exemplos
O exemplo seguinte demonstra o uso da StackFrame classe para fornecer a informação do quadro de pilha para um traço de pilha.
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
O exemplo seguinte demonstra a utilização dos membros da StackFrame turma.
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
Observações
A é criado e colocado StackFrame na pilha de chamadas para cada chamada de função feita durante a execução de uma thread. A estrutura da pilha inclui MethodBase sempre informação e, opcionalmente, inclui o nome do ficheiro, o número da linha e o número da coluna.
StackFrame a informação será mais informativa com as configurações de compilação de Debug. Por defeito, as builds de Debug incluem símbolos de debug, enquanto as de Release não têm. Os símbolos de depuração contêm a maior parte do ficheiro, nome do método, número de linha e informação da coluna usada na construção StackFrame de objetos.
Construtores
| Name | Description |
|---|---|
| StackFrame() |
Inicializa uma nova instância da StackFrame classe. |
| StackFrame(Boolean) |
Inicializa uma nova instância da StackFrame classe, capturando opcionalmente a informação da fonte. |
| StackFrame(Int32, Boolean) |
Inicializa uma nova instância da StackFrame classe que corresponde a um frame acima do frame de stack atual, capturando opcionalmente informação de origem. |
| StackFrame(Int32) |
Inicializa uma nova instância da StackFrame classe que corresponde a um quadro acima do quadro de pilha atual. |
| StackFrame(String, Int32, Int32) |
Inicializa uma nova instância da StackFrame classe que contém apenas o nome do ficheiro, número da linha e número da coluna. |
| StackFrame(String, Int32) |
Inicializa uma nova instância da StackFrame classe que contém apenas o nome do ficheiro e o número de linha indicados. |
Campos
| Name | Description |
|---|---|
| OFFSET_UNKNOWN |
Define o valor que é devolvido do método GetNativeOffset() ou GetILOffset() quando o deslocamento nativo ou Microsoft intermédio (MSIL) é desconhecido. Este campo é constante. |
Métodos
| Name | Description |
|---|---|
| Equals(Object) |
Determina se o objeto especificado é igual ao objeto atual. (Herdado de Object) |
| GetFileColumnNumber() |
Obtém o número da coluna no ficheiro que contém o código que está a ser executado. Esta informação é normalmente extraída dos símbolos de depuração do executável. |
| GetFileLineNumber() |
Obtém o número da linha no ficheiro que contém o código que está a ser executado. Esta informação é normalmente extraída dos símbolos de depuração do executável. |
| GetFileName() |
Obtém o nome do ficheiro que contém o código que está a ser executado. Esta informação é normalmente extraída dos símbolos de depuração do executável. |
| GetHashCode() |
Serve como função de hash predefinida. (Herdado de Object) |
| GetILOffset() |
Obtém o offset do início do código da Microsoft intermediate language (MSIL) para o método que está a ser executado. Este deslocamento pode ser uma aproximação dependendo de o compilador just-in-time (JIT) estar a gerar código de depuração. A geração desta informação de depuração é controlada pelo DebuggableAttribute. |
| GetMethod() |
Obtém o método em que o frame está a ser executado. |
| GetNativeOffset() |
Obtém o offset a partir do início do código nativo compilado just-in-time (JIT) para o método que está a ser executado. A geração desta informação de depuração é controlada pela DebuggableAttribute classe. |
| GetType() |
Obtém o Type da instância atual. (Herdado de Object) |
| MemberwiseClone() |
Cria uma cópia superficial do atual Object. (Herdado de Object) |
| ToString() |
Constrói uma representação legível do traço de pilha. |
Métodos da Extensão
| Name | Description |
|---|---|
| GetNativeImageBase(StackFrame) |
Devolve um ponteiro para o endereço base da imagem nativa que este frame de pilha está a executar. |
| GetNativeIP(StackFrame) |
Recebe um ponteiro de interface para o início do código nativo do método que está a ser executado. |
| HasILOffset(StackFrame) |
Indica se existe um deslocamento a partir do início do código IL para o método que está a ser executado. |
| HasMethod(StackFrame) |
Indica se está disponível informação sobre o método em que a trama especificada está a ser executada. |
| HasNativeImage(StackFrame) |
Indica se a imagem nativa está disponível para o quadro de pilha especificado. |
| HasSource(StackFrame) |
Indica se o ficheiro que contém o código que o frame de pilha especificado está a executar está disponível. |