ConfigurationErrorsException Класс

Определение

Исключение, которое вызывается в случае ошибки конфигурации.The exception that is thrown when a configuration error has occurred.

public ref class ConfigurationErrorsException : System::Configuration::ConfigurationException
[System.Serializable]
public class ConfigurationErrorsException : System.Configuration.ConfigurationException
type ConfigurationErrorsException = class
    inherit ConfigurationException
Public Class ConfigurationErrorsException
Inherits ConfigurationException
Наследование
Атрибуты

Примеры

В следующем примере кода создается пользовательский раздел и создается ConfigurationErrorsException исключение при изменении его свойств.The following code example creates a custom section and generates a ConfigurationErrorsException exception when it modifies its properties.

using System;
using System.Configuration;
using System.Collections.Specialized;
using System.Collections;

namespace Samples.AspNet
{

    // Define a custom section.
    public sealed class CustomSection :
       ConfigurationSection
    {
        public CustomSection()
        {
        }

        [ConfigurationProperty("fileName", DefaultValue = "default.txt",
                    IsRequired = true, IsKey = false)]
        [StringValidator(InvalidCharacters = " ~!@#$%^&*()[]{}/;'\"|\\",
            MinLength = 1, MaxLength = 60)]
        public string FileName
        {
            get
            {
                return (string)this["fileName"];
            }
            set
            {
                this["fileName"] = value;
            }
        }

        [ConfigurationProperty("maxUsers", DefaultValue = (long)10,
            IsRequired = false)]
        [LongValidator(MinValue = 1, MaxValue = 100,
            ExcludeRange = false)]
        public long MaxUsers
        {
            get
            {
                return (long)this["maxUsers"];
            }
            set
            {
                this["maxUsers"] = value;
            }
        }

    }


    // Create the custom section and write it to
    // the configuration file.
    class UsingConfigurationErrorsException
    {
        // Create a custom section.
        static UsingConfigurationErrorsException()
        {
            // Get the application configuration file.
            System.Configuration.Configuration config =
                    ConfigurationManager.OpenExeConfiguration(
                    ConfigurationUserLevel.None);

            // If the section does not exist in the configuration
            // file, create it and save it to the file.
            if (config.Sections["CustomSection"] == null)
            {
                CustomSection custSection = new CustomSection();
                config.Sections.Add("CustomSection", custSection);
                custSection =
                    config.GetSection("CustomSection") as CustomSection;
                custSection.SectionInformation.ForceSave = true;
                config.Save(ConfigurationSaveMode.Full);
            }
        }
        
        // Modify a custom section and cause configuration 
        // error exceptions.
        static void ModifyCustomSection()
        {

            try
            {
                // Get the application configuration file.
                System.Configuration.Configuration config =
                        ConfigurationManager.OpenExeConfiguration(
                        ConfigurationUserLevel.None);

                CustomSection custSection =
                   config.Sections["CustomSection"] as CustomSection;

                // Change the section properties.
                custSection.FileName = "newName.txt";
                
                // Cause an exception.
                custSection.MaxUsers = custSection.MaxUsers + 100;

                if (!custSection.ElementInformation.IsLocked)
                    config.Save();
                else
                    Console.WriteLine(
                        "Section was locked, could not update.");
            }
            catch (ConfigurationErrorsException err)
            {

                string msg = err.Message;
                Console.WriteLine("Message: {0}", msg);

                string fileName = err.Filename;
                Console.WriteLine("Filename: {0}", fileName);

                int lineNumber = err.Line;
                Console.WriteLine("Line: {0}", lineNumber.ToString());

                string bmsg = err.BareMessage;
                Console.WriteLine("BareMessage: {0}", bmsg);

                string source = err.Source;
                Console.WriteLine("Source: {0}", source);

                string st = err.StackTrace;
                Console.WriteLine("StackTrace: {0}", st);

            }
        }

        static void Main(string[] args)
        {
            ModifyCustomSection();
        }

    
    }
}
Imports System.Configuration
Imports System.Collections.Specialized
Imports System.Collections



' Define a custom section.

NotInheritable Public Class CustomSection
    Inherits ConfigurationSection
    
    Public Sub New() 
    
    End Sub
    
    
    <ConfigurationProperty("fileName", DefaultValue:="default.txt", IsRequired:=True, IsKey:=False), StringValidator(InvalidCharacters:=" ~!@#$%^&*()[]{}/;'""|\", MinLength:=1, MaxLength:=60)> _
    Public Property FileName() As String
        Get
            Return CStr(Me("fileName"))
        End Get
        Set(ByVal value As String)
            Me("fileName") = value
        End Set
    End Property
    
    
    <ConfigurationProperty("maxUsers", DefaultValue:=10, IsRequired:=False), LongValidator(MinValue:=1, MaxValue:=100, ExcludeRange:=False)> _
    Public Property MaxUsers() As Long
        Get
            Return Fix(Me("maxUsers"))
        End Get
        Set(ByVal value As Long)
            Me("maxUsers") = value
        End Set
    End Property
End Class


' Create the custom section and write it to
' the configuration file.

Class UsingConfigurationErrorsException
    
    ' Create a custom section.
    Shared Sub New()

        ' Get the application configuration file.
        Dim config _
        As System.Configuration.Configuration = _
        ConfigurationManager.OpenExeConfiguration( _
        ConfigurationUserLevel.None)

        ' If the section does not exist in the configuration
        ' file, create it and save it to the file.
        If config.Sections("CustomSection") Is Nothing Then
            Dim custSection As New CustomSection()
            config.Sections.Add("CustomSection", custSection)
            custSection = config.GetSection("CustomSection")
            custSection.SectionInformation.ForceSave = True
            config.Save(ConfigurationSaveMode.Full)
        End If

    End Sub
    
    
    ' Modify a custom section and cause configuration 
    ' error exceptions.
    Shared Sub ModifyCustomSection() 
        
        Try
            ' Get the application configuration file.
            Dim config _
            As System.Configuration.Configuration = _
            ConfigurationManager.OpenExeConfiguration( _
            ConfigurationUserLevel.None)

            Dim custSection _
            As CustomSection = _
            config.Sections("CustomSection")
             
            ' Change the section properties.
            custSection.FileName = "newName.txt"
            
            ' Cause an exception.
            custSection.MaxUsers = _
            custSection.MaxUsers + 100
            
            If Not custSection.ElementInformation.IsLocked Then
                config.Save()
            Else
                Console.WriteLine( _
                "Section was locked, could not update.")
            End If
        Catch err As ConfigurationErrorsException
            
            Dim msg As String = err.Message
            Console.WriteLine("Message: {0}", msg)
            Dim fileName As String = err.Filename
            Console.WriteLine("Filename: {0}", _
            fileName)
            Dim lineNumber As Integer = err.Line
            Console.WriteLine("Line: {0}", _
            lineNumber.ToString())
            Dim bmsg As String = err.BareMessage
            Console.WriteLine("BareMessage: {0}", bmsg)
            Dim src As String = err.Source
            Console.WriteLine("Source: {0}", src)
            Dim st As String = err.StackTrace
            Console.WriteLine("StackTrace: {0}", st)
        End Try

    End Sub

    Shared Sub Main(ByVal args() As String) 
        ModifyCustomSection()
    
    End Sub
End Class

В следующем примере показан фрагмент конфигурации, используемый в предыдущем примере.The following example is a configuration excerpt used by the previous example.

<?xml version="1.0" encoding="utf-8"?>  
<configuration>  
  <configSections>  
    <section name="CustomSection" type="Samples.AspNet.CustomSection,   
      ConfigurationErrorsException, Version=1.0.0.0, Culture=neutral,   
      PublicKeyToken=null" allowDefinition="Everywhere"   
      allowExeDefinition="MachineToApplication"   
      restartOnExternalChanges="true" />  
  </configSections>  
  <CustomSection fileName="default.txt" maxUsers="10" />  
</configuration>  

Комментарии

ConfigurationErrorsException Исключение возникает при возникновении любой ошибки во время чтения или запись сведений о конфигурации.The ConfigurationErrorsException exception is thrown when any error occurs while configuration information is being read or written.

Конструкторы

ConfigurationErrorsException()

Инициализирует новый экземпляр класса ConfigurationErrorsException.Initializes a new instance of the ConfigurationErrorsException class.

ConfigurationErrorsException(SerializationInfo, StreamingContext)

Инициализирует новый экземпляр класса ConfigurationErrorsException.Initializes a new instance of the ConfigurationErrorsException class.

ConfigurationErrorsException(String)

Инициализирует новый экземпляр класса ConfigurationErrorsException.Initializes a new instance of the ConfigurationErrorsException class.

ConfigurationErrorsException(String, Exception)

Инициализирует новый экземпляр класса ConfigurationErrorsException.Initializes a new instance of the ConfigurationErrorsException class.

ConfigurationErrorsException(String, Exception, String, Int32)

Инициализирует новый экземпляр класса ConfigurationErrorsException.Initializes a new instance of a ConfigurationErrorsException class.

ConfigurationErrorsException(String, Exception, XmlNode)

Инициализирует новый экземпляр класса ConfigurationErrorsException.Initializes a new instance of the ConfigurationErrorsException class.

ConfigurationErrorsException(String, Exception, XmlReader)

Инициализирует новый экземпляр класса ConfigurationErrorsException.Initializes a new instance of the ConfigurationErrorsException class.

ConfigurationErrorsException(String, String, Int32)

Инициализирует новый экземпляр класса ConfigurationErrorsException.Initializes a new instance of the ConfigurationErrorsException class.

ConfigurationErrorsException(String, XmlNode)

Инициализирует новый экземпляр класса ConfigurationErrorsException.Initializes a new instance of the ConfigurationErrorsException class.

ConfigurationErrorsException(String, XmlReader)

Инициализирует новый экземпляр класса ConfigurationErrorsException.Initializes a new instance of the ConfigurationErrorsException class.

Свойства

BareMessage

Получает описание причины возникновения данного исключения конфигурации.Gets a description of why this configuration exception was thrown.

Data

Возвращает коллекцию пар ключ/значение, предоставляющие дополнительные сведения об исключении, определяемые пользователем.Gets a collection of key/value pairs that provide additional user-defined information about the exception.

(Унаследовано от Exception)
Errors

Получает коллекцию ошибок, которые подробно описывают причины возникновения данного исключения ConfigurationErrorsException.Gets a collection of errors that detail the reasons this ConfigurationErrorsException exception was thrown.

Filename

Получает путь к файлу конфигурации, который привел к возникновению данного исключения конфигурации.Gets the path to the configuration file that caused this configuration exception to be thrown.

HelpLink

Получает или задает ссылку на файл справки, связанный с этим исключением.Gets or sets a link to the help file associated with this exception.

(Унаследовано от Exception)
HResult

Возвращает или задает HRESULT — кодированное числовое значение, присвоенное определенному исключению.Gets or sets HRESULT, a coded numerical value that is assigned to a specific exception.

(Унаследовано от Exception)
InnerException

Возвращает экземпляр класса Exception, который вызвал текущее исключение.Gets the Exception instance that caused the current exception.

(Унаследовано от Exception)
Line

Получает номер строки в файле конфигурации, в которой возникло данное исключение.Gets the line number within the configuration file at which this configuration exception was thrown.

Message

Получает расширенное описание причины возникновения данного исключения конфигурации.Gets an extended description of why this configuration exception was thrown.

Source

Возвращает или задает имя приложения или объекта, вызывавшего ошибку.Gets or sets the name of the application or the object that causes the error.

(Унаследовано от Exception)
StackTrace

Получает строковое представление непосредственных кадров в стеке вызова.Gets a string representation of the immediate frames on the call stack.

(Унаследовано от Exception)
TargetSite

Возвращает метод, создавший текущее исключение.Gets the method that throws the current exception.

(Унаследовано от Exception)

Методы

Equals(Object)

Определяет, равен ли указанный объект текущему объекту.Determines whether the specified object is equal to the current object.

(Унаследовано от Object)
GetBaseException()

При переопределении в производном классе возвращает исключение Exception, которое является корневой причиной одного или нескольких последующих исключений.When overridden in a derived class, returns the Exception that is the root cause of one or more subsequent exceptions.

(Унаследовано от Exception)
GetFilename(XmlNode)

Получает путь к файлу конфигурации, из которого загружался внутренний объект XmlNode, когда возникло данное исключение конфигурации.Gets the path to the configuration file from which the internal XmlNode object was loaded when this configuration exception was thrown.

GetFilename(XmlReader)

Получает путь к файлу конфигурации, из которого считывался внутренний объект XmlReader, когда возникло данное исключение конфигурации.Gets the path to the configuration file that the internal XmlReader was reading when this configuration exception was thrown.

GetHashCode()

Служит в качестве хэш-функции по умолчанию.Serves as the default hash function.

(Унаследовано от Object)
GetLineNumber(XmlNode)

Получает номер строки в файле конфигурации, которую представлял внутренний объект XmlNode, когда возникло данное исключение конфигурации.Gets the line number within the configuration file that the internal XmlNode object represented when this configuration exception was thrown.

GetLineNumber(XmlReader)

Получает номер строки в файле конфигурации, которую обрабатывал внутренний объект XmlReader, когда возникло данное исключение конфигурации.Gets the line number within the configuration file that the internal XmlReader object was processing when this configuration exception was thrown.

GetObjectData(SerializationInfo, StreamingContext)

Задает объект SerializationInfo с именем файла и номером строки, в которых возникло данное исключение конфигурации.Sets the SerializationInfo object with the file name and line number at which this configuration exception occurred.

GetType()

Возвращает тип среды выполнения текущего экземпляра.Gets the runtime type of the current instance.

(Унаследовано от Exception)
MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Унаследовано от Object)
ToString()

Создает и возвращает строковое представление текущего исключения.Creates and returns a string representation of the current exception.

(Унаследовано от Exception)

События

SerializeObjectState

Возникает, когда исключение сериализовано для создания объекта состояния исключения, содержащего сериализованные данные об исключении.Occurs when an exception is serialized to create an exception state object that contains serialized data about the exception.

(Унаследовано от Exception)

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