AsyncCompletedEventArgs AsyncCompletedEventArgs AsyncCompletedEventArgs AsyncCompletedEventArgs Class

Definition

Stellt Daten für das MethodNameCompleted-Ereignis bereit.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
Vererbung
AsyncCompletedEventArgsAsyncCompletedEventArgsAsyncCompletedEventArgsAsyncCompletedEventArgs
Abgeleitet

Beispiele

Im folgenden Codebeispiel wird die Verwendung AsyncOperation von veranschaulicht, um die Lebensdauer von asynchronen Vorgängen zu verfolgen.The following code example demonstrates using an AsyncOperation to track the lifetime of asynchronous operations. Dieses Codebeispiel ist Teil eines größeren Beispiels, das für die System.ComponentModel.AsyncOperationManager -Klasse bereitgestellt wird.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

Hinweise

Wenn Sie eine Klasse verwenden, die die Übersicht über das ereignisbasierte asynchrone Musterimplementiert, stellt die Klasse ein MethodName Completed -Ereignis bereit.If you are using a class that implements the Event-based Asynchronous Pattern Overview, the class will provide a MethodNameCompleted event. Wenn Sie dem-Ereignis eine Instanz System.ComponentModel.AsyncCompletedEventHandler des-Delegaten hinzufügen, erhalten Sie Informationen über das Ergebnis von asynchronen Vorgängen AsyncCompletedEventArgs im-Parameter der entsprechenden Ereignishandlermethode.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.

Der Ereignishandlerdelegat der Client Anwendung kann Cancelled die-Eigenschaft überprüfen, um zu bestimmen, ob die asynchrone Aufgabe abgebrochen wurde.The client application's event-handler delegate can check the Cancelled property to determine if the asynchronous task was cancelled.

Der Ereignishandlerdelegat der Client Anwendung kann Error die-Eigenschaft überprüfen, um zu bestimmen, ob während der Ausführung der asynchronen Aufgabe eine Ausnahme aufgetreten ist.The client application's event-handler delegate can check the Error property to determine if an exception occurred during execution of the asynchronous task.

Wenn die Klasse mehrere asynchrone Methoden oder mehrere Aufrufe derselben asynchronen Methode unterstützt, können Sie bestimmen, welche Aufgabe das MethodName Completed -Ereignis ausgelöst hat, indem Sie UserState den Wert der-Eigenschaft überprüfen.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. Ihr Code muss diese Token nachverfolgen, die als Task-IDs bezeichnet werden, da die entsprechenden asynchronen Aufgaben gestartet und beendet werden.Your code will need to track these tokens, known as task IDs, as their corresponding asynchronous tasks start and complete.

Hinweise für Vererber

Klassen, die das ereignisbasierte asynchrone Muster befolgen, können Ereignisse ausgelöst werden, um Clients über den Status der ausstehenden asynchronen Vorgänge zu benachrichtigen.Classes that follow the Event-based Asynchronous Pattern can raise events to alert clients about the status of pending asynchronous operations. Wenn die Klasse ein MethodName Completed -Ereignis bereitstellt, können Sie AsyncCompletedEventArgs die Clients über das Ergebnis von asynchronen Vorgängen informieren.If the class provides a MethodNameCompleted event, you can use the AsyncCompletedEventArgs to tell clients about the outcome of asynchronous operations.

Möglicherweise möchten Sie den Clients mehr Informationen über das Ergebnis eines asynchronen Vorgangs als einen AsyncCompletedEventArgs der-Vorgänge mitteilen.You may want to communicate to clients more information about the outcome of an asynchronous operation than an AsyncCompletedEventArgs accommodates. In diesem Fall können Sie eine eigene Klasse von der AsyncCompletedEventArgs -Klasse ableiten und zusätzliche private Instanzvariablen und entsprechende schreibgeschützte öffentliche Eigenschaften bereitstellen.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. Ruft die RaiseExceptionIfNecessary() -Methode vor dem Zurückgeben des Eigenschafts Werts auf, wenn der Vorgang abgebrochen wurde oder ein Fehler aufgetreten ist.Call the RaiseExceptionIfNecessary() method before returning the property value, in case the operation was canceled or an error occurred.

Konstruktoren

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

Initialisiert eine neue Instanz der AsyncCompletedEventArgs-Klasse.Initializes a new instance of the AsyncCompletedEventArgs class.

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

Initialisiert eine neue Instanz der AsyncCompletedEventArgs-Klasse.Initializes a new instance of the AsyncCompletedEventArgs class.

Eigenschaften

Cancelled Cancelled Cancelled Cancelled

Ruft einen Wert ab, der angibt, ob ein asynchroner Vorgang abgebrochen wurde.Gets a value indicating whether an asynchronous operation has been canceled.

Error Error Error Error

Ruft einen Wert ab, der angibt, welcher Fehler während eines asynchronen Vorgangs aufgetreten ist.Gets a value indicating which error occurred during an asynchronous operation.

UserState UserState UserState UserState

Ruft den eindeutigen Bezeichner der asynchronen Aufgabe ab.Gets the unique identifier for the asynchronous task.

Methoden

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

Bestimmt, ob das angegebene Objekt mit dem aktuellen Objekt identisch ist.Determines whether the specified object is equal to the current object.

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

Fungiert als Standardhashfunktion.Serves as the default hash function.

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

Ruft den Type der aktuellen Instanz ab.Gets the Type of the current instance.

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

Erstellt eine flache Kopie des aktuellen Object.Creates a shallow copy of the current Object.

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

Löst eine benutzerdefinierte Ausnahme aus, wenn bei einem asynchronen Vorgang ein Fehler aufgetreten ist.Raises a user-supplied exception if an asynchronous operation failed.

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

Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt.Returns a string that represents the current object.

(Inherited from Object)

Gilt für:

Siehe auch