AsyncCompletedEventArgs.Error Eigenschaft

Referenz

Definition

Namespace:: System.ComponentModel

Assembly:: System.ComponentModel.EventBasedAsync.dll

Assembly:: System.dll

Assembly:: netstandard.dll

Quelle:: AsyncCompletedEvent.cs

Quelle:: AsyncCompletedEvent.cs

Quelle:: AsyncCompletedEvent.cs

Wichtig

Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.

Ruft einen Wert ab, der angibt, welcher Fehler während eines asynchronen Vorgangs aufgetreten ist.

public:
 property Exception ^ Error { Exception ^ get(); };

public Exception Error { get; }

public Exception? Error { get; }

member this.Error : Exception

Public ReadOnly Property Error As Exception

Eigenschaftswert

Exception

Eine Exception-Instanz, wenn während eines asynchronen Vorgangs ein Fehler aufgetreten ist, andernfalls null.

Beispiele

Das folgende Codebeispiel veranschaulicht die Verwendung von zum AsyncOperation Nachverfolgen der Lebensdauer asynchroner Vorgänge. Dieses Codebeispiel ist Teil eines größeren Beispiels, das für die System.ComponentModel.AsyncOperationManager-Klasse bereitgestellt wird.

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;

Imports System.Collections
Imports System.Collections.Specialized
Imports System.ComponentModel
Imports System.Drawing
Imports System.Globalization
Imports System.Threading
Imports System.Windows.Forms

// 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;
        }
    }
}

' 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 Sub primeNumberCalculator1_CalculatePrimeCompleted( _
    ByVal sender As Object, _
    ByVal e As CalculatePrimeCompletedEventArgs) _
    Handles primeNumberCalculator1.CalculatePrimeCompleted

    Dim taskId As Guid = CType(e.UserState, Guid)

    If e.Cancelled Then
        Dim result As String = "Canceled"

        Dim lvi As ListViewItem = UpdateListViewItem( _
            taskId, _
            result)

        If (lvi IsNot Nothing) Then
            lvi.BackColor = Color.Pink
            lvi.Tag = Nothing
        End If

    ElseIf e.Error IsNot Nothing Then

        Dim result As String = "Error"

        Dim lvi As ListViewItem = UpdateListViewItem( _
            taskId, result)

        If (lvi IsNot Nothing) Then
            lvi.BackColor = Color.Red
            lvi.ForeColor = Color.White
            lvi.Tag = Nothing
        End If
    Else
        Dim result As Boolean = e.IsPrime

        Dim lvi As ListViewItem = UpdateListViewItem( _
            taskId, _
            result, _
            e.FirstDivisor)

        If (lvi IsNot Nothing) Then
            lvi.BackColor = Color.LightGray
            lvi.Tag = Nothing
        End If
    End If

End Sub

Hinweise

Wenn während eines asynchronen Vorgangs eine Ausnahme ausgelöst wird, weist die -Klasse die Ausnahme der Error -Eigenschaft zu. Der Ereignishandlerdelegat der Clientanwendung sollte die Error -Eigenschaft überprüfen, bevor auf Eigenschaften in einer klasse zugegriffen wird, die von AsyncCompletedEventArgsabgeleitet wird. Andernfalls löst die -Eigenschaft eine aus TargetInvocationException , deren InnerException Eigenschaft einen Verweis auf Errorenthält.

Der Wert der Error -Eigenschaft ist null , wenn der Vorgang abgebrochen wurde.

Hinweise für Vererber

Wenn Sie schreibgeschützte Eigenschaften in einer abgeleiteten Klasse bereitstellen, müssen Sie die RaiseExceptionIfNecessary() -Methode in Ihrer Eigenschaftenimplementierung aufrufen. Dadurch wird verhindert, dass Clients auf Eigenschaften zugreifen, die aufgrund eines Fehlers im asynchronen Vorgang möglicherweise ungültig sind.

Gilt für:

Produkt	Versionen
.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

Freigeben über