AsyncCompletedEventArgs Klasa

Definicja

Dostarcza dane dla zdarzeniaCompleted MethodName .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
Dziedziczenie
AsyncCompletedEventArgs
Pochodne

Przykłady

Poniższy przykład kodu demonstruje użycie AsyncOperation do śledzenia okresu istnienia operacji asynchronicznych.The following code example demonstrates using an AsyncOperation to track the lifetime of asynchronous operations. Ten przykładowy kod jest częścią większego przykładu udostępnionego dla klasy 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

Uwagi

Jeśli używasz klasy, która implementuje Przegląd asynchronicznego wzorca opartego na zdarzeniach, Klasa dostarczy zdarzenie MethodNameCompleted.If you are using a class that implements the Event-based Asynchronous Pattern Overview, the class will provide a MethodNameCompleted event. Jeśli dodasz wystąpienie delegata System.ComponentModel.AsyncCompletedEventHandler do zdarzenia, otrzymasz informacje o wyniku operacji asynchronicznych w parametrze AsyncCompletedEventArgs odpowiedniej metodzie obsługi zdarzeń.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.

Delegat programu obsługi zdarzeń aplikacji klienta może sprawdzić Właściwość Cancelled, aby określić, czy zadanie asynchroniczne zostało anulowane.The client application's event-handler delegate can check the Cancelled property to determine if the asynchronous task was cancelled.

Delegat programu obsługi zdarzeń aplikacji klienta może sprawdzić Właściwość Error, aby określić, czy wystąpił wyjątek podczas wykonywania zadania asynchronicznego.The client application's event-handler delegate can check the Error property to determine if an exception occurred during execution of the asynchronous task.

Jeśli klasa obsługuje wiele metod asynchronicznych lub wiele wywołań tej samej metody asynchronicznej, można określić, które zadanie wywołało zdarzenieCompleted MethodName , sprawdzając wartość właściwości 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. Kod będzie musiał śledzić te tokeny, znane jako identyfikatory zadań, tak jak odpowiadające im zadania asynchroniczne są uruchamiane i kompletne.Your code will need to track these tokens, known as task IDs, as their corresponding asynchronous tasks start and complete.

Uwagi dotyczące dziedziczenia

Klasy, które są zgodne ze wzorcem asynchronicznym opartym na zdarzeniach, mogą zgłaszać zdarzenia do alertów klientów o stanie oczekujących operacji asynchronicznych.Classes that follow the Event-based Asynchronous Pattern can raise events to alert clients about the status of pending asynchronous operations. Jeśli Klasa zawiera zdarzenie MethodNameCompleted, można użyć AsyncCompletedEventArgs do informowania klientów o wyniku operacji asynchronicznych.If the class provides a MethodNameCompleted event, you can use the AsyncCompletedEventArgs to tell clients about the outcome of asynchronous operations.

Możesz chcieć komunikować się z klientami, aby uzyskać więcej informacji na temat wyniku operacji asynchronicznej niż AsyncCompletedEventArgs.You may want to communicate to clients more information about the outcome of an asynchronous operation than an AsyncCompletedEventArgs accommodates. W takim przypadku można utworzyć własną klasę z klasy AsyncCompletedEventArgs i udostępnić dodatkowe zmienne wystąpień prywatnych oraz odpowiednie właściwości publiczne tylko do odczytu.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. Przed zwróceniem wartości właściwości Wywołaj metodę RaiseExceptionIfNecessary(), jeśli operacja została anulowana lub wystąpił błąd.Call the RaiseExceptionIfNecessary() method before returning the property value, in case the operation was canceled or an error occurred.

Konstruktory

AsyncCompletedEventArgs()

Inicjuje nowe wystąpienie klasy AsyncCompletedEventArgs klasy.Initializes a new instance of the AsyncCompletedEventArgs class.

AsyncCompletedEventArgs(Exception, Boolean, Object)

Inicjuje nowe wystąpienie klasy AsyncCompletedEventArgs klasy.Initializes a new instance of the AsyncCompletedEventArgs class.

Właściwości

Cancelled

Pobiera wartość wskazującą, czy operacja asynchroniczna została anulowana.Gets a value indicating whether an asynchronous operation has been canceled.

Error

Pobiera wartość wskazującą, który błąd wystąpił podczas operacji asynchronicznej.Gets a value indicating which error occurred during an asynchronous operation.

UserState

Pobiera unikatowy identyfikator zadania asynchronicznego.Gets the unique identifier for the asynchronous task.

Metody

Equals(Object)

Określa, czy dany obiekt jest taki sam, jak bieżący obiekt.Determines whether the specified object is equal to the current object.

(Odziedziczone po Object)
GetHashCode()

Służy jako domyślna funkcja skrótu.Serves as the default hash function.

(Odziedziczone po Object)
GetType()

Pobiera Type bieżącego wystąpienia.Gets the Type of the current instance.

(Odziedziczone po Object)
MemberwiseClone()

Tworzy skróconą kopię bieżącego Object.Creates a shallow copy of the current Object.

(Odziedziczone po Object)
RaiseExceptionIfNecessary()

Zgłasza wyjątek dostarczony przez użytkownika, jeśli operacja asynchroniczna nie powiodła się.Raises a user-supplied exception if an asynchronous operation failed.

ToString()

Zwraca ciąg reprezentujący bieżący obiekt.Returns a string that represents the current object.

(Odziedziczone po Object)

Dotyczy

Zobacz też