AsyncCompletedEventArgs Class

Definition

Specifica dati per l'evento 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
Inheritance
AsyncCompletedEventArgs
Derived

Examples

Nell'esempio di codice riportato di seguito viene illustrato l'utilizzo di un AsyncOperation per tenere traccia della durata delle operazioni asincrone.The following code example demonstrates using an AsyncOperation to track the lifetime of asynchronous operations. Questo esempio di codice fa parte di un esempio più ampio fornito per la classe 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

Remarks

Se si usa una classe che implementa la Panoramica del modello asincrono basato su eventi, la classe fornirà un evento MethodNameCompleted.If you are using a class that implements the Event-based Asynchronous Pattern Overview, the class will provide a MethodNameCompleted event. Se si aggiunge un'istanza del System.ComponentModel.AsyncCompletedEventHandler delegato all'evento, si riceveranno informazioni sul risultato delle operazioni asincrone nel parametro AsyncCompletedEventArgs del metodo del gestore eventi corrispondente.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.

Il delegato del gestore eventi dell'applicazione client può controllare la proprietà Cancelled per determinare se l'attività asincrona è stata annullata.The client application's event-handler delegate can check the Cancelled property to determine if the asynchronous task was cancelled.

Il delegato del gestore eventi dell'applicazione client può controllare la proprietà Error per determinare se si è verificata un'eccezione durante l'esecuzione dell'attività asincrona.The client application's event-handler delegate can check the Error property to determine if an exception occurred during execution of the asynchronous task.

Se la classe supporta più metodi asincroni o più chiamate allo stesso metodo asincrono, è possibile determinare quale attività ha generato l'evento methodnameCompleted controllando il valore della proprietà 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. Il codice deve tenere traccia di questi token, noti come ID attività, in quanto le attività asincrone corrispondenti vengono avviate e completate.Your code will need to track these tokens, known as task IDs, as their corresponding asynchronous tasks start and complete.

Notes to Inheritors

Le classi che seguono il modello asincrono basato su eventi possono generare eventi per segnalare ai client lo stato delle operazioni asincrone in sospeso.Classes that follow the Event-based Asynchronous Pattern can raise events to alert clients about the status of pending asynchronous operations. Se la classe fornisce un evento methodnameCompleted, è possibile usare l'AsyncCompletedEventArgs per indicare ai client il risultato delle operazioni asincrone.If the class provides a MethodNameCompleted event, you can use the AsyncCompletedEventArgs to tell clients about the outcome of asynchronous operations.

È possibile che si desideri comunicare ai client ulteriori informazioni sul risultato di un'operazione asincrona rispetto a una AsyncCompletedEventArgs.You may want to communicate to clients more information about the outcome of an asynchronous operation than an AsyncCompletedEventArgs accommodates. In questo caso, è possibile derivare la propria classe dalla classe AsyncCompletedEventArgs e fornire variabili di istanza privata aggiuntive e corrispondenti proprietà pubbliche di sola lettura.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. Chiamare il metodo RaiseExceptionIfNecessary() prima di restituire il valore della proprietà, nel caso in cui l'operazione sia stata annullata o si sia verificato un errore.Call the RaiseExceptionIfNecessary() method before returning the property value, in case the operation was canceled or an error occurred.

Constructors

AsyncCompletedEventArgs()

Inizializza una nuova istanza della classe AsyncCompletedEventArgs.Initializes a new instance of the AsyncCompletedEventArgs class.

AsyncCompletedEventArgs(Exception, Boolean, Object)

Inizializza una nuova istanza della classe AsyncCompletedEventArgs.Initializes a new instance of the AsyncCompletedEventArgs class.

Properties

Cancelled

Ottiene un valore che indica se un'operazione asincrona è stata annullata.Gets a value indicating whether an asynchronous operation has been canceled.

Error

Ottiene un valore che indica l'errore verificatosi durante un'operazione asincrona.Gets a value indicating which error occurred during an asynchronous operation.

UserState

Ottiene l’identificatore univoco per l'attività asincrona.Gets the unique identifier for the asynchronous task.

Methods

Equals(Object)

Determina se l'oggetto specificato è uguale all'oggetto corrente.Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode()

Funge da funzione hash predefinita.Serves as the default hash function.

(Inherited from Object)
GetType()

Ottiene l'oggetto Type dell'istanza corrente.Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone()

Crea una copia superficiale dell'oggetto Object corrente.Creates a shallow copy of the current Object.

(Inherited from Object)
RaiseExceptionIfNecessary()

Genera un'eccezione fornita dall'utente in caso di errore in un'operazione asincrona.Raises a user-supplied exception if an asynchronous operation failed.

ToString()

Restituisce una stringa che rappresenta l'oggetto corrente.Returns a string that represents the current object.

(Inherited from Object)

Applies to

See also