Exception.StackTrace Свойство

Определение

Получает строковое представление непосредственных кадров в стеке вызова.

public virtual string StackTrace { get; }
public virtual string? StackTrace { get; }

Значение свойства

Строка, описывающая непосредственные фреймы стека вызова. Если трассировка стека не доступна (например, до очистки стека из throw инструкции), значение равно null.

Реализации

Примеры

В следующем примере кода создается Exception , а затем перехватывается и отображается трассировка стека с помощью StackTrace свойства .

// Example for the Exception.HelpLink, Exception.Source,
// Exception.StackTrace, and Exception.TargetSite properties.
using System;

namespace NDP_UE_CS
{
    // Derive an exception; the constructor sets the HelpLink and
    // Source properties.
    class LogTableOverflowException : Exception
    {
        const string overflowMessage = "The log table has overflowed.";

        public LogTableOverflowException(
            string auxMessage, Exception inner ) :
                base( String.Format( "{0} - {1}",
                    overflowMessage, auxMessage ), inner )
        {
            this.HelpLink = "https://learn.microsoft.com";
            this.Source = "Exception_Class_Samples";
        }
    }

    class LogTable
    {
        public LogTable( int numElements )
        {
            logArea = new string[ numElements ];
            elemInUse = 0;
        }

        protected string[ ] logArea;
        protected int       elemInUse;

        // The AddRecord method throws a derived exception if
        // the array bounds exception is caught.
        public    int       AddRecord( string newRecord )
        {
            try
            {
                logArea[ elemInUse ] = newRecord;
                return elemInUse++;
            }
            catch( Exception e )
            {
                throw new LogTableOverflowException(
                    String.Format( "Record \"{0}\" was not logged.",
                        newRecord ), e );
            }
        }
    }

    class OverflowDemo
    {
        // Create a log table and force an overflow.
        public static void Main()
        {
            LogTable log = new LogTable( 4 );

            Console.WriteLine(
                "This example of \n   Exception.Message, \n" +
                "   Exception.HelpLink, \n   Exception.Source, \n" +
                "   Exception.StackTrace, and \n   Exception." +
                "TargetSite \ngenerates the following output." );

            try
            {
                for( int count = 1; ; count++ )
                {
                    log.AddRecord(
                        String.Format(
                            "Log record number {0}", count ) );
                }
            }
            catch( Exception ex )
            {
                Console.WriteLine( "\nMessage ---\n{0}", ex.Message );
                Console.WriteLine(
                    "\nHelpLink ---\n{0}", ex.HelpLink );
                Console.WriteLine( "\nSource ---\n{0}", ex.Source );
                Console.WriteLine(
                    "\nStackTrace ---\n{0}", ex.StackTrace );
                Console.WriteLine(
                    "\nTargetSite ---\n{0}", ex.TargetSite );
            }
        }
    }
}

/*
This example of
   Exception.Message,
   Exception.HelpLink,
   Exception.Source,
   Exception.StackTrace, and
   Exception.TargetSite
generates the following output.

Message ---
The log table has overflowed. - Record "Log record number 5" was not logged.

HelpLink ---
https://learn.microsoft.com

Source ---
Exception_Class_Samples

StackTrace ---
   at NDP_UE_CS.LogTable.AddRecord(String newRecord)
   at NDP_UE_CS.OverflowDemo.Main()

TargetSite ---
Int32 AddRecord(System.String)
*/

Комментарии

В стеке выполнения отслеживаются все методы, выполняемые в данный момент времени. Трассировка вызовов метода называется трассировкой стека. Список трассировки стека позволяет отслеживать стек вызовов по номеру строки в методе, в котором возникает исключение.

Свойство StackTrace возвращает кадры стека вызовов, которые происходят в месте, где было создано исключение. Сведения о дополнительных кадрах в стеке вызовов можно получить, создав новый экземпляр System.Diagnostics.StackTrace класса и используя его StackTrace.ToString метод .

Среда CLR обновляет трассировку стека всякий раз, когда в коде приложения возникает исключение (с помощью throw ключевое слово). Если исключение было повторно создано в методе, отличном от метода, в котором оно было создано изначально, трассировка стека содержит как расположение в методе, где было первоначально создано исключение, так и расположение в методе, в котором было повторно создано исключение. Если исключение возникает, а затем повторно выполняется в том же методе, трассировка стека содержит только расположение, в котором было повторно создано исключение, и не включает расположение, в котором изначально было создано исключение.

Свойство StackTrace может не сообщать о количестве вызовов методов, как ожидалось, из-за преобразований кода, таких как встраивание, которые происходят во время оптимизации.

Примечания для тех, кто наследует этот метод

Свойство StackTrace переопределяется в классах, требующих контроля над содержимым трассировки стека или форматом.

По умолчанию трассировка стека фиксируется непосредственно перед созданием объекта исключения. Используется StackTrace для получения сведений трассировки стека, если исключение не создается.

Применяется к

Продукт Версии
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 2.0, 2.1
UWP 10.0

См. также раздел