AsyncCompletedEventArgs.Error Właściwość

Definicja

Pobiera wartość wskazującą, który błąd wystąpił podczas operacji asynchronicznej.

C#
public Exception Error { get; }
C#
public Exception? Error { get; }

Wartość właściwości

Wystąpienie Exception , jeśli wystąpił błąd podczas operacji asynchronicznej; w przeciwnym razie null.

Przykłady

W poniższym przykładzie kodu pokazano użycie elementu AsyncOperation do śledzenia okresu istnienia operacji asynchronicznych. Ten przykład kodu jest częścią większego przykładu udostępnionego System.ComponentModel.AsyncOperationManager dla klasy .

C#
using System;
using System.Collections;
using System.Collections.Specialized;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Globalization;
using System.Threading;
using System.Windows.Forms;
C#
// This event handler updates the ListView control when the
// PrimeNumberCalculator raises the CalculatePrimeCompleted
// event. The ListView item is updated with the appropriate
// outcome of the calculation: Canceled, Error, or result.
private void primeNumberCalculator1_CalculatePrimeCompleted(
    object sender, 
    CalculatePrimeCompletedEventArgs e)
{
    Guid taskId = (Guid)e.UserState;

    if (e.Cancelled)
    {   
        string result = "Canceled";

        ListViewItem lvi = UpdateListViewItem(taskId, result);

        if (lvi != null)
        {
            lvi.BackColor = Color.Pink;
            lvi.Tag = null;
        }
    }
    else if (e.Error != null)
    {
        string result = "Error";

        ListViewItem lvi = UpdateListViewItem(taskId, result);

        if (lvi != null)
        {
            lvi.BackColor = Color.Red;
            lvi.ForeColor = Color.White;
            lvi.Tag = null;
        }
    }
    else
    {   
        bool result = e.IsPrime;

        ListViewItem lvi = UpdateListViewItem(
            taskId, 
            result, 
            e.FirstDivisor);

        if (lvi != null)
        {
            lvi.BackColor = Color.LightGray;
            lvi.Tag = null;
        }
    }
}

Uwagi

Jeśli podczas operacji asynchronicznej zostanie zgłoszony wyjątek, klasa przypisze wyjątek do Error właściwości . Delegat obsługi zdarzeń aplikacji klienckiej powinien sprawdzić Error właściwość przed uzyskaniem dostępu do wszystkich właściwości klasy pochodnej z AsyncCompletedEventArgsklasy . W przeciwnym razie właściwość zgłosi TargetInvocationException obiekt z właściwością InnerException zawierającą odwołanie do Errorklasy .

Wartość Error właściwości to null , jeśli operacja została anulowana.

Uwagi dotyczące dziedziczenia

Jeśli podasz właściwości tylko do odczytu w klasie pochodnej, pamiętaj, aby wywołać metodę RaiseExceptionIfNecessary() w implementacji właściwości. Uniemożliwia to klientom uzyskiwanie dostępu do właściwości, które są potencjalnie nieprawidłowe z powodu błędu w operacji asynchronicznej.

Dotyczy

Produkt Wersje
.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 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 2.0, 2.1
UWP 10.0

Zobacz też