AsyncCompletedEventArgs Class

Definición

Proporciona datos para el evento MethodNameCompleted. Provides data for the MethodNameCompleted event.

public class AsyncCompletedEventArgs : EventArgs
Herencia
AsyncCompletedEventArgs
Derivado

Ejemplos

En el ejemplo de código siguiente se muestra cómo utilizar un AsyncOperation para realizar el seguimiento de la duración de las operaciones asincrónicas.The following code example demonstrates using an AsyncOperation to track the lifetime of asynchronous operations. Este ejemplo de código forma parte de un ejemplo más extenso proporcionado para el System.ComponentModel.AsyncOperationManager clase.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

Comentarios

Si usa una clase que implementa el Event-based Asynchronous Pattern Overview, la clase proporcionará un MethodName Completed eventos.If you are using a class that implements the Event-based Asynchronous Pattern Overview, the class will provide a MethodNameCompleted event. Si agrega una instancia de la System.ComponentModel.AsyncCompletedEventHandler delegado al evento, recibirá información sobre el resultado de operaciones asincrónicas en el AsyncCompletedEventArgs parámetro del método de controlador de eventos correspondiente.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.

Delegado de controlador de eventos de la aplicación cliente puede comprobar la Cancelled propiedad para determinar si se canceló la tarea asincrónica.The client application's event-handler delegate can check the Cancelled property to determine if the asynchronous task was cancelled.

Delegado de controlador de eventos de la aplicación cliente puede comprobar la Error propiedad para determinar si se produjo una excepción durante la ejecución de la tarea asincrónica.The client application's event-handler delegate can check the Error property to determine if an exception occurred during execution of the asynchronous task.

Si la clase admite varios métodos asincrónicos o varias llamadas al mismo método asincrónico, se puede determinar qué tarea provocó el MethodName Completed evento comprobando el valor de la UserState propiedad.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. El código debe realizar un seguimiento de estos tokens, conocidos como Id. de tarea, como sus correspondientes tareas asincrónicas se inician y se completan.Your code will need to track these tokens, known as task IDs, as their corresponding asynchronous tasks start and complete.

Notas a los desarrolladores de herederos

Las clases que siguen el modelo asincrónico basado en eventos pueden provocar eventos a los clientes de alerta sobre el estado de las operaciones asincrónicas pendientes. Si la clase proporciona un MethodName Completed eventos, puede usar el AsyncCompletedEventArgs indique a los clientes sobre el resultado de las operaciones asincrónicas. Es posible que desee comunicar a los clientes obtener más información sobre el resultado de una operación asincrónica que un AsyncCompletedEventArgs admite. En este caso, puede derivar su propia clase de la AsyncCompletedEventArgs clase y proporcionar las variables de instancia privados adicionales y propiedades públicas de solo lectura correspondientes. Llame a la RaiseExceptionIfNecessary() método antes de devolver el valor de propiedad, en caso de la operación se canceló o se produjo un error.

Classes that follow the Event-based Asynchronous Pattern can raise events to alert clients about the status of pending asynchronous operations. If the class provides a MethodNameCompleted event, you can use the AsyncCompletedEventArgs to tell clients about the outcome of asynchronous operations. You may want to communicate to clients more information about the outcome of an asynchronous operation than an AsyncCompletedEventArgs accommodates. 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. Call the RaiseExceptionIfNecessary() method before returning the property value, in case the operation was canceled or an error occurred.

Constructores

AsyncCompletedEventArgs()

Inicializa una nueva instancia de la clase AsyncCompletedEventArgs. Initializes a new instance of the AsyncCompletedEventArgs class.

AsyncCompletedEventArgs(Exception, Boolean, Object)

Inicializa una nueva instancia de la clase AsyncCompletedEventArgs. Initializes a new instance of the AsyncCompletedEventArgs class.

Propiedades

Cancelled

Obtiene un valor que indica si se ha cancelado una operación asincrónica. Gets a value indicating whether an asynchronous operation has been canceled.

Error

Obtiene un valor que indica el error que se produjo durante una operación asincrónica. Gets a value indicating which error occurred during an asynchronous operation.

UserState

Obtiene el identificador único de la tarea asincrónica. Gets the unique identifier for the asynchronous task.

Métodos

Equals(Object)

Determina si el objeto especificado es igual al objeto actual. Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode()

Sirve como la función hash predeterminada. Serves as the default hash function.

(Inherited from Object)
GetType()

Obtiene el Type de la instancia actual. Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone()

Crea una copia superficial del Object actual. Creates a shallow copy of the current Object.

(Inherited from Object)
RaiseExceptionIfNecessary()

Genera una excepción proporcionada por el usuario si se ha producido un error en una operación asincrónica. Raises a user-supplied exception if an asynchronous operation failed.

ToString()

Devuelve una cadena que representa el objeto actual. Returns a string that represents the current object.

(Inherited from Object)

Se aplica a

Consultar también