AsyncCompletedEventArgs AsyncCompletedEventArgs AsyncCompletedEventArgs AsyncCompletedEventArgs Class

Определение

Предоставляет данные для события MethodNameCompleted.Provides data for the MethodNameCompleted event.

public ref class AsyncCompletedEventArgs : EventArgs
public class AsyncCompletedEventArgs : EventArgs
type AsyncCompletedEventArgs = class
    inherit EventArgs
Public Class AsyncCompletedEventArgs
Inherits EventArgs
Наследование
AsyncCompletedEventArgsAsyncCompletedEventArgsAsyncCompletedEventArgsAsyncCompletedEventArgs
Производный

Примеры

В следующем примере кода показано использование 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
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

Комментарии

Если вы используете класс, реализующий Общие сведения об асинхронной модели на основе событий, класс предоставит событие имя_метода Completed .If you are using a class that implements the Event-based Asynchronous Pattern Overview, the class will provide a MethodNameCompleted event. При добавлении экземпляра System.ComponentModel.AsyncCompletedEventHandler делегата в событие будут получены сведения о результатах асинхронных операций AsyncCompletedEventArgs в параметре соответствующего метода обработчика событий.If you add an instance of the System.ComponentModel.AsyncCompletedEventHandler delegate to the event, you will receive information about the outcome of asynchronous operations in the AsyncCompletedEventArgs parameter of the corresponding event-handler method.

Делегат обработчика событий клиентского приложения может проверить Cancelled свойство, чтобы определить, была ли отменена асинхронная задача.The client application's event-handler delegate can check the Cancelled property to determine if the asynchronous task was cancelled.

Делегат обработчика событий клиентского приложения может проверить Error свойство, чтобы определить, произошло ли исключение во время выполнения асинхронной задачи.The client application's event-handler delegate can check the Error property to determine if an exception occurred during execution of the asynchronous task.

Если класс поддерживает несколько асинхронных методов или несколько вызовов одного и того же асинхронного метода, можно определить, какая задача вызвала событие имя_метода Completed , проверив значение UserState свойства.If the class supports multiple asynchronous methods, or multiple calls to the same asynchronous method, you can determine which task raised the MethodNameCompleted event by checking the value of the UserState property. В коде потребуется отслеживание этих маркеров, называемых идентификаторами задач, по мере запуска и завершения соответствующих асинхронных задач.Your code will need to track these tokens, known as task IDs, as their corresponding asynchronous tasks start and complete.

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

Классы, которые следуют за асинхронной моделью на основе событий, могут создавать события для предупреждения клиентов о состоянии ожидающих асинхронных операций.Classes that follow the Event-based Asynchronous Pattern can raise events to alert clients about the status of pending asynchronous operations. Если класс предоставляет событие имя_метода Completed , можно использовать AsyncCompletedEventArgs для информирования клиентов о результатах асинхронных операций.If the class provides a MethodNameCompleted event, you can use the AsyncCompletedEventArgs to tell clients about the outcome of asynchronous operations.

Возможно, вам потребуется связаться с клиентами, чтобы получить дополнительные сведения о результатах асинхронной операции AsyncCompletedEventArgs .You may want to communicate to clients more information about the outcome of an asynchronous operation than an AsyncCompletedEventArgs accommodates. В этом случае можно создать собственный класс из AsyncCompletedEventArgs класса и предоставить дополнительные переменные закрытого экземпляра и соответствующие общедоступные свойства только для чтения.In this case, you can derive your own class from the AsyncCompletedEventArgs class and provide additional private instance variables and corresponding read-only public properties. Вызовите RaiseExceptionIfNecessary() метод перед возвратом значения свойства, если операция была отменена или произошла ошибка.Call the RaiseExceptionIfNecessary() method before returning the property value, in case the operation was canceled or an error occurred.

Конструкторы

AsyncCompletedEventArgs() AsyncCompletedEventArgs() AsyncCompletedEventArgs() AsyncCompletedEventArgs()

Инициализирует новый экземпляр класса AsyncCompletedEventArgs.Initializes a new instance of the AsyncCompletedEventArgs class.

AsyncCompletedEventArgs(Exception, Boolean, Object) AsyncCompletedEventArgs(Exception, Boolean, Object) AsyncCompletedEventArgs(Exception, Boolean, Object) AsyncCompletedEventArgs(Exception, Boolean, Object)

Инициализирует новый экземпляр класса AsyncCompletedEventArgs.Initializes a new instance of the AsyncCompletedEventArgs class.

Свойства

Cancelled Cancelled Cancelled Cancelled

Возвращает значение, показывающее, была ли отменена асинхронная операция.Gets a value indicating whether an asynchronous operation has been canceled.

Error Error Error Error

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

UserState UserState UserState UserState

Возвращает уникальный идентификатор для асинхронной задачи.Gets the unique identifier for the asynchronous task.

Методы

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Определяет, равен ли заданный объект текущему объекту.Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Служит хэш-функцией по умолчанию.Serves as the default hash function.

(Inherited from Object)
GetType() GetType() GetType() GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Inherited from Object)
RaiseExceptionIfNecessary() RaiseExceptionIfNecessary() RaiseExceptionIfNecessary() RaiseExceptionIfNecessary()

Вызывает предоставленное пользователем исключение в случае неудачного выполнения асинхронной операции.Raises a user-supplied exception if an asynchronous operation failed.

ToString() ToString() ToString() ToString()

Возвращает строку, представляющую текущий объект.Returns a string that represents the current object.

(Inherited from Object)

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

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