Exception.Message Свойство

Определение

Пространство имен:

System

Сборки:

netstandard.dll, System.Runtime.dll

Исходный код:

Exception.cs

Возвращает сообщение, описывающее текущее исключение.

C#

public virtual string Message { get; }

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

String

Сообщение об ошибке, объясняющее причину исключения, или пустая строка ("").

Примеры

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

C#

// 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)
*/

Комментарии

Сообщения об ошибках предназначены для разработчика, который обрабатывает исключение. Текст Message свойства должен полностью описывать ошибку и, по возможности, также должен объяснять, как исправить ошибку. Обработчики исключений верхнего уровня могут отображать сообщение конечным пользователям, поэтому следует убедиться, что оно грамматически правильно и каждое предложение сообщения заканчивается точкой. Не используйте вопросительные знаки или восклицательные знаки. Если приложение использует локализованные сообщения об исключениях, убедитесь, что они переведены точно.

Важно!

Не раскрывайте конфиденциальную информацию в сообщениях об исключениях, не проверив наличие соответствующих разрешений.

Значение Message свойства включается в сведения, возвращаемые .ToString Свойство Message задается только при создании Exception. Если конструктору для текущего экземпляра не было предоставлено сообщение, система предоставляет сообщение по умолчанию, отформатированный с использованием текущего системного языка и региональных параметров.

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

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

Сообщение об ошибке должно быть локализовано.

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