AggregateException Класс

Определение

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

System

Сборки:

netstandard.dll, System.Runtime.dll

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

AggregateException.cs

Представляет одну или несколько ошибок, возникающих во время выполнения приложения.

public ref class AggregateException : Exception

public class AggregateException : Exception

type AggregateException = class
    inherit Exception

Public Class AggregateException
Inherits Exception

Наследование

Object

Exception

AggregateException

Примеры

В следующем примере выполняется AggregateException перехват исключения и вызывается Handle метод для обработки каждого исключения, содержащегося в нем. Компиляция и запуск примера с первой task1 переменной должна привести к AggregateException объекту UnauthorizedAccessException , который содержит исключение. Закомментируя такую строку, раскомментируя вторую task1 переменную и скомпилируя и выполняя пример, создает AggregateException объект, содержащий IndexOutOfRangeException исключение.

using System;
using System.IO;
using System.Threading.Tasks;

class Example
{
   static async Task Main(string[] args)
   {
      // Get a folder path whose directories should throw an UnauthorizedAccessException.
      string path = Directory.GetParent(
                              Environment.GetFolderPath(
                              Environment.SpecialFolder.UserProfile)).FullName;

      // Use this line to throw UnauthorizedAccessException, which we handle.
      Task<string[]> task1 = Task<string[]>.Factory.StartNew(() => GetAllFiles(path));

      // Use this line to throw an exception that is not handled.
      // Task task1 = Task.Factory.StartNew(() => { throw new IndexOutOfRangeException(); } );
      try
      {
          await task1;
      }
      catch (UnauthorizedAccessException)
      {
          Console.WriteLine("Caught unauthorized access exception-await behavior");
      }
      catch (AggregateException ae)
      {
          Console.WriteLine("Caught aggregate exception-Task.Wait behavior");
          ae.Handle((x) =>
          {
              if (x is UnauthorizedAccessException) // This we know how to handle.
              {
                  Console.WriteLine("You do not have permission to access all folders in this path.");
                  Console.WriteLine("See your network administrator or try another path.");
                  return true;
              }
              return false; // Let anything else stop the application.
          });
      }

      Console.WriteLine("task1 Status: {0}{1}", task1.IsCompleted ? "Completed," : "",
                                                task1.Status);
   }

   static string[] GetAllFiles(string str)
   {
      // Should throw an UnauthorizedAccessException exception.
      return System.IO.Directory.GetFiles(str, "*.txt", System.IO.SearchOption.AllDirectories);
   }
}
// The example displays the following output if the file access task is run:
//       You do not have permission to access all folders in this path.
//       See your network administrator or try another path.
//       task1 Status: Completed,Faulted
// It displays the following output if the second task is run:
//       Unhandled Exception: System.AggregateException: One or more errors occurred. ---
//       > System.IndexOutOfRangeException: Index was outside the bounds of the array.
//          at Example.<Main>b__0()
//          at System.Threading.Tasks.Task.Execute()
//          --- End of inner exception stack trace ---
//          at System.AggregateException.Handle(Func`2 predicate)
//          at Example.Main(String[] args)

open System
open System.IO
open System.Threading.Tasks

let getAllFiles str =
    // Should throw an UnauthorizedAccessException exception.
    System.IO.Directory.GetFiles(str, "*.txt", System.IO.SearchOption.AllDirectories)

// Get a folder path whose directories should throw an UnauthorizedAccessException.
let path =
    let directory =
        Environment.SpecialFolder.UserProfile
        |> Environment.GetFolderPath
        |> Directory.GetParent
    directory.FullName

// Use this line to throw an exception that is not handled.
// let task1 = Task<string []>.Factory.StartNew(fun () -> raise (IndexOutOfRangeException()) )
let task1 = Task.Factory.StartNew(fun () -> getAllFiles (path))

let execute () =
    try
        task1.Wait()
    with
    | :? UnauthorizedAccessException -> printfn "Caught unauthorized access exception-await behavior"
    | :? AggregateException as ae ->
        printfn "Caught aggregate exception-Task.Wait behavior"

        ae.Handle (fun x ->
            match x with
            | :? UnauthorizedAccessException ->
                printfn "You do not have permission to access all folders in this path."
                printfn "See your network administrator or try another path."
                true
            | _ -> false)
    printfn $"""task1 Status: {if task1.IsCompleted then "Completed," else ""}{task1.Status}"""

execute ()

// The example displays the following output if the file access task is run:
//       You do not have permission to access all folders in this path.
//       See your network administrator or try another path.
//       task1 Status: Completed,Faulted
// It displays the following output if the second task is run:
//       Unhandled exception. System.AggregateException: One or more errors occurred. (Index was outside the bounds of the array.) (Index was outside the bounds of the array.)
//        ---> System.IndexOutOfRangeException: Index was outside the bounds of the array.
//          at Exception1.task1@19.Invoke()
//          at System.Threading.Tasks.Task`1.InnerInvoke()
//          at System.Threading.Tasks.Task.<>c.<.cctor>b__277_0(Object obj)
//          at System.Threading.ExecutionContext.RunFromThreadPoolDispatchLoop(Thread threadPoolThread, ExecutionContext executionContext, ContextCallback callback, Object state)   
//       --- End of stack trace from previous location ---
//          at System.Threading.ExecutionContext.RunFromThreadPoolDispatchLoop(Thread threadPoolThread, ExecutionContext executionContext, ContextCallback callback, Object state)   
//          at System.Threading.Tasks.Task.ExecuteWithThreadLocal(Task& currentTaskSlot, Thread threadPoolThread)
//          --- End of inner exception stack trace ---
//          at System.AggregateException.Handle(Func`2 predicate)
//          at <StartupCode$exception1>.$Exception1.main@()

Imports System.IO
Imports System.Threading.Tasks

Module Example
    Sub Main()
        ' Get a folder path whose directories should throw an UnauthorizedAccessException.
        Dim path As String = Directory.GetParent(
                                       Environment.GetFolderPath(
                                       Environment.SpecialFolder.UserProfile)).FullName

        ' Use this line to throw UnauthorizedAccessException, which we handle.
        Dim task1 = Task(Of String()).Factory.StartNew(Function() GetAllFiles(path))

        ' Use this line to throw an exception that is not handled.
        ' Task task1 = Task.Factory.StartNew(Sub() Throw New IndexOutOfRangeException() )
        Try
            task1.Wait()
        Catch ae As AggregateException
            ae.Handle(Function(x)
                          If TypeOf (x) Is UnauthorizedAccessException Then ' This we know how to handle
                              Console.WriteLine("You do not have permission to access all folders in this path.")
                              Console.WriteLine("See your network administrator or try another path.")
                              Return True
                          Else
                              Return False ' Let anything else stop the application.
                          End If
                      End Function)
        End Try

      Console.WriteLine("task1 Status: {0}{1}", If(task1.IsCompleted, "Completed,", ""), 
                                                task1.Status)
    End Sub

    Function GetAllFiles(ByVal str As String) As String()
        ' Should throw an UnauthorizedAccessException exception. 
        Return System.IO.Directory.GetFiles(str, "*.txt", System.IO.SearchOption.AllDirectories)
    End Function
End Module

Комментарии

AggregateException используется для консолидации нескольких сбоев в один объект исключения, который можно вызвать. Он широко используется в библиотеке параллельных задач (TPL) и Parallel LINQ (PLINQ). Дополнительные сведения см. в разделе "Обработка исключений " и "Практическое руководство. Обработка исключений в запросе PLINQ". Дополнительные сведения см. в записи Aggregating Exceptions в блоге .NET Вопросов.

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

Имя	Описание
AggregateException()	Инициализирует новый экземпляр AggregateException класса с помощью системного сообщения, описывающего ошибку.
AggregateException(Exception[])	Инициализирует новый экземпляр AggregateException класса со ссылками на внутренние исключения, которые являются причиной этого исключения.
AggregateException(IEnumerable<Exception>)	Инициализирует новый экземпляр AggregateException класса со ссылками на внутренние исключения, которые являются причиной этого исключения.
AggregateException(SerializationInfo, StreamingContext)	Устаревшие.. Инициализирует новый экземпляр AggregateException класса сериализованными данными.
AggregateException(String, Exception)	Инициализирует новый экземпляр AggregateException класса с указанным сообщением об ошибке и ссылкой на внутреннее исключение, которое является причиной этого исключения.
AggregateException(String, Exception[])	Инициализирует новый экземпляр AggregateException класса с указанным сообщением об ошибке и ссылается на внутренние исключения, которые являются причиной этого исключения.
AggregateException(String, IEnumerable<Exception>)	Инициализирует новый экземпляр AggregateException класса с указанным сообщением об ошибке и ссылается на внутренние исключения, которые являются причиной этого исключения.
AggregateException(String)	Инициализирует новый экземпляр AggregateException класса с указанным сообщением, описывающим ошибку.

Свойства

Имя	Описание
Data	Возвращает коллекцию пар "ключ-значение", которые предоставляют дополнительные пользовательские сведения об исключении. (Унаследовано от Exception)
HelpLink	Возвращает или задает ссылку на файл справки, связанный с этим исключением. (Унаследовано от Exception)
HResult	Возвращает или задает HRESULT, закодированное числовое значение, назначенное определенному исключению. (Унаследовано от Exception)
InnerException	Возвращает экземпляр Exception, вызвавшего текущее исключение. (Унаследовано от Exception)
InnerExceptions	Возвращает коллекцию Exception экземпляров только для чтения, вызвавшей текущее исключение.
Message	Возвращает сообщение, описывающее исключение.
Source	Возвращает или задает имя приложения или объекта, вызывающего ошибку. (Унаследовано от Exception)
StackTrace	Возвращает строковое представление непосредственных кадров в стеке вызовов. (Унаследовано от Exception)
TargetSite	Возвращает метод, который вызывает текущее исключение. (Унаследовано от Exception)

Методы

Имя	Описание
Equals(Object)	Определяет, равен ли указанный объект текущему объекту. (Унаследовано от Object)
Flatten()	Неструктурирует AggregateException экземпляры в один новый экземпляр.
GetBaseException()	Exception Возвращает первопричину этого исключения. Это исключение является корневым или первым AggregateException , который содержит либо несколько внутренних исключений, либо не содержит внутренних исключений вообще.
GetHashCode()	Служит хэш-функцией по умолчанию. (Унаследовано от Object)
GetObjectData(SerializationInfo, StreamingContext)	Устаревшие.. Инициализирует новый экземпляр AggregateException класса сериализованными данными.
GetType()	Возвращает тип среды выполнения текущего экземпляра. (Унаследовано от Exception)
Handle(Func<Exception,Boolean>)	Вызывает обработчик для каждого Exception , содержащегося в этом AggregateExceptionпараметре.
MemberwiseClone()	Создает неглубокую копию текущей Object. (Унаследовано от Object)
ToString()	Создает и возвращает строковое представление текущего AggregateException.

События

Имя	Описание
SerializeObjectState	Устаревшие.. Происходит при сериализации исключения для создания объекта состояния исключения, содержащего сериализованные данные об исключении. (Унаследовано от Exception)

Потокобезопасность

Все общедоступные и защищенные элементы AggregateException являются потокобезопасными и могут использоваться одновременно из нескольких потоков.