AggregateException Clase

Definición

Espacio de nombres:

System

Ensamblados:

netstandard.dll, System.Runtime.dll

Source:

AggregateException.cs

Representa uno o varios errores que se producen durante la ejecución de la aplicación.

public ref class AggregateException : Exception

public class AggregateException : Exception

type AggregateException = class
    inherit Exception

Public Class AggregateException
Inherits Exception

Herencia

Object

Exception

AggregateException

Ejemplos

En el ejemplo siguiente se detecta la AggregateException excepción y se llama al Handle método para controlar cada excepción que contiene. La compilación y ejecución del ejemplo con la primera task1 variable debe dar lugar a un AggregateException objeto que contenga una UnauthorizedAccessException excepción. Comentar esa línea, quitar la marca de comentario de la segunda task1 variable y compilar y ejecutar el ejemplo genera un AggregateException objeto que contiene una IndexOutOfRangeException excepción.

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

Comentarios

AggregateException se usa para consolidar varios errores en un único objeto de excepción iniciable. Se usa ampliamente en la biblioteca paralela de tareas (TPL) y En paralelo LINQ (PLINQ). Para obtener más información, vea Control de excepciones y Cómo: Controlar excepciones en una consulta PLINQ. Para obtener más información, consulte la entrada Aggregating Exceptions en el blog .NET Matters.

Constructores

Nombre	Description
AggregateException()	Inicializa una nueva instancia de la AggregateException clase con un mensaje proporcionado por el sistema que describe el error.
AggregateException(Exception[])	Inicializa una nueva instancia de la AggregateException clase con referencias a las excepciones internas que son la causa de esta excepción.
AggregateException(IEnumerable<Exception>)	Inicializa una nueva instancia de la AggregateException clase con referencias a las excepciones internas que son la causa de esta excepción.
AggregateException(SerializationInfo, StreamingContext)	Obsoletos. Inicializa una nueva instancia de la AggregateException clase con datos serializados.
AggregateException(String, Exception)	Inicializa una nueva instancia de la AggregateException clase con un mensaje de error especificado y una referencia a la excepción interna que es la causa de esta excepción.
AggregateException(String, Exception[])	Inicializa una nueva instancia de la AggregateException clase con un mensaje de error especificado y hace referencia a las excepciones internas que son la causa de esta excepción.
AggregateException(String, IEnumerable<Exception>)	Inicializa una nueva instancia de la AggregateException clase con un mensaje de error especificado y hace referencia a las excepciones internas que son la causa de esta excepción.
AggregateException(String)	Inicializa una nueva instancia de la AggregateException clase con un mensaje especificado que describe el error.

Propiedades

Nombre	Description
Data	Obtiene una colección de pares clave-valor que proporcionan información adicional definida por el usuario sobre la excepción. (Heredado de Exception)
HelpLink	Obtiene o establece un vínculo al archivo de ayuda asociado a esta excepción. (Heredado de Exception)
HResult	Obtiene o establece HRESULT, un valor numérico codificado que se asigna a una excepción específica. (Heredado de Exception)
InnerException	Obtiene la Exception instancia que provocó la excepción actual. (Heredado de Exception)
InnerExceptions	Obtiene una colección de solo lectura de las Exception instancias que provocaron la excepción actual.
Message	Obtiene un mensaje que describe la excepción.
Source	Obtiene o establece el nombre de la aplicación o el objeto que provoca el error. (Heredado de Exception)
StackTrace	Obtiene una representación de cadena de los fotogramas inmediatos en la pila de llamadas. (Heredado de Exception)
TargetSite	Obtiene el método que produce la excepción actual. (Heredado de Exception)

Métodos

Nombre	Description
Equals(Object)	Determina si el objeto especificado es igual al objeto actual. (Heredado de Object)
Flatten()	Aplana una AggregateException instancia de en una única instancia nueva.
GetBaseException()	Devuelve que Exception es la causa principal de esta excepción. Esta excepción es la excepción raíz o la primera AggregateException que contiene varias excepciones internas o ninguna excepción interna.
GetHashCode()	Actúa como función hash predeterminada. (Heredado de Object)
GetObjectData(SerializationInfo, StreamingContext)	Obsoletos. Inicializa una nueva instancia de la AggregateException clase con datos serializados.
GetType()	Obtiene el tipo de tiempo de ejecución de la instancia actual. (Heredado de Exception)
Handle(Func<Exception,Boolean>)	Invoca un controlador en cada Exception uno contenido por este AggregateException.
MemberwiseClone()	Crea una copia superficial del Objectactual. (Heredado de Object)
ToString()	Crea y devuelve una representación de cadena del objeto actual AggregateException.

Eventos

Nombre	Description
SerializeObjectState	Obsoletos. Se produce cuando se serializa una excepción para crear un objeto de estado de excepción que contiene datos serializados sobre la excepción. (Heredado de Exception)

Seguridad para subprocesos

Todos los miembros públicos y protegidos de AggregateException son seguros para subprocesos y se pueden usar simultáneamente desde varios subprocesos.