Sdílet prostřednictvím

AsyncCompletedEventArgs.Error Vlastnost

  • Reference

Definice

Obor názvů:
System.ComponentModel
Sestavení:
System.ComponentModel.EventBasedAsync.dll
Sestavení:
System.dll
Sestavení:
netstandard.dll
Zdroj:
AsyncCompletedEvent.cs
Zdroj:
AsyncCompletedEvent.cs
Zdroj:
AsyncCompletedEvent.cs

Získá hodnotu označující, ke které chybě došlo během asynchronní operace.

public:
 property Exception ^ Error { Exception ^ get(); };
public Exception Error { get; }
public Exception? Error { get; }
member this.Error : Exception
Public ReadOnly Property Error As Exception

Hodnota vlastnosti

Exception

Instance Exception , pokud došlo k chybě během asynchronní operace; jinak null.

Příklady

Následující příklad kódu ukazuje použití ke AsyncOperation sledování životnosti asynchronních operací. Tento příklad kódu je součástí většího příkladu System.ComponentModel.AsyncOperationManager pro třídu .

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

Poznámky

Pokud je výjimka vyvolána během asynchronní operace, třída přiřadí výjimku vlastnosti Error . Delegát obslužné rutiny událostí klientské aplikace by měl vlastnost zkontrolovat Error před přístupem k vlastnostem ve třídě odvozené z AsyncCompletedEventArgs. V opačném případě by vlastnost vyvolala TargetInvocationException vlastnost se svou InnerException vlastností, která obsahuje odkaz na Error.

Hodnota Error vlastnosti je null , pokud byla operace zrušena.

Poznámky pro dědice

Pokud v odvozené třídě zadáte vlastnosti jen pro čtení, nezapomeňte v implementaci vlastnosti volat metodu RaiseExceptionIfNecessary() . To zabrání klientům v přístupu k vlastnostem, které jsou potenciálně neplatné z důvodu selhání asynchronní operace.

Platí pro

Viz také