AsyncCompletedEventArgs.Error AsyncCompletedEventArgs.Error AsyncCompletedEventArgs.Error AsyncCompletedEventArgs.Error Property

Определение

Возвращает значение, показывающее, какая ошибка произошла в течение асинхронной операции.Gets a value indicating which error occurred during an asynchronous operation.

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

Значение свойства

Экземпляр исключения Exception, если в ходе асинхронной операции произошла ошибка; в противном случае — значение null.An Exception instance, if an error occurred during an asynchronous operation; otherwise null.

Примеры

В следующем примере кода показано использование AsyncOperation для мониторинга времени существования асинхронных операций.The following code example demonstrates using an AsyncOperation to track the lifetime of asynchronous operations. Этот пример кода является частью большого примера, System.ComponentModel.AsyncOperationManager приведенного для класса.This code example is part of a larger example provided for the System.ComponentModel.AsyncOperationManager class.

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

Комментарии

Если во время асинхронной операции возникает исключение, класс присвоит исключение Error свойству.If an exception is raised during an asynchronous operation, the class will assign the exception to the Error property. Делегат Error обработчика событий клиентского приложения должен проверить свойство, прежде чем обращаться к любым свойствам класса, производного от AsyncCompletedEventArgs; в противном случае свойство TargetInvocationException InnerException вызовет свойство со свойством, содержащим Ссылка на Error.The client application's event-handler delegate should check the Error property before accessing any properties in a class derived from AsyncCompletedEventArgs; otherwise, the property will raise a TargetInvocationException with its InnerException property holding a reference to Error.

Значение Error свойства равно null , если операция была отменена.The value of the Error property is null if the operation was canceled.

Примечания для тех, кто наследует этот метод

Если вы предоставляете свойства только для чтения в производном классе, обязательно вызовите RaiseExceptionIfNecessary() метод в реализации свойства.If you provide read-only properties in a derived class, be sure to call the RaiseExceptionIfNecessary() method in your property implementation. Это предотвращает доступ клиентов к свойствам, которые потенциально недействительны из-за сбоя в асинхронной операции.This prevents clients from accessing properties that are potentially not valid due to a failure in the asynchronous operation.

Применяется к

Дополнительно