AsyncCompletedEventArgs AsyncCompletedEventArgs AsyncCompletedEventArgs AsyncCompletedEventArgs Class

Definizione

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
Ereditarietà
AsyncCompletedEventArgsAsyncCompletedEventArgsAsyncCompletedEventArgsAsyncCompletedEventArgs
Derivato

Esempi

Esempio di codice seguente viene illustrato come utilizzare 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 è parte di un esempio più esaustivo disponibile per il System.ComponentModel.AsyncOperationManager classe.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

Commenti

Se si usa una classe che implementa il Event-based Asynchronous Pattern Overview, la classe fornirà un NomeMetodo Completed evento.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 AsyncCompletedEventArgs parametro 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.

Delegato del gestore eventi dell'applicazione client può controllare il Cancelled proprietà 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.

Delegato del gestore eventi dell'applicazione client può controllare il Error proprietà 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 al metodo asincrono stesso, è possibile determinare quale attività ha generato il NomeMetodo Completed evento controllando il valore della UserState proprietà.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 necessario tenere traccia di questi token, noti come ID attività, come alle corrispondenti attività asincrona avviare e completare.Your code will need to track these tokens, known as task IDs, as their corresponding asynchronous tasks start and complete.

Note per gli eredi

Le classi che seguono il modello asincrono basato su eventi possono generare eventi per i client degli avvisi relativi allo stato di 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 una NomeMetodo Completed evento, è possibile usare il AsyncCompletedEventArgs di indicare ai client informazioni risultanti di operazioni asincrone.If the class provides a MethodNameCompleted event, you can use the AsyncCompletedEventArgs to tell clients about the outcome of asynchronous operations.

È possibile comunicare ai client ulteriori informazioni sull'esito dell'operazione asincrona rispetto a un AsyncCompletedEventArgs alcune variazioni.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 dal AsyncCompletedEventArgs classe e specificare le variabili di istanza privata aggiuntiva e la proprietà in sola lettura pubblica corrispondente.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 RaiseExceptionIfNecessary() metodo prima di restituire il valore della proprietà, nel caso in cui l'operazione è stata annullata o si è verificato un errore.Call the RaiseExceptionIfNecessary() method before returning the property value, in case the operation was canceled or an error occurred.

Costruttori

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

Inizializza una nuova istanza della classe 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)

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

Proprietà

Cancelled Cancelled Cancelled Cancelled

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

Error Error Error 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 UserState UserState UserState

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

Metodi

Equals(Object) Equals(Object) Equals(Object) 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() GetHashCode() GetHashCode() GetHashCode()

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

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

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

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

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

(Inherited from Object)
RaiseExceptionIfNecessary() RaiseExceptionIfNecessary() RaiseExceptionIfNecessary() 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() ToString() ToString() ToString()

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

(Inherited from Object)

Si applica a

Vedi anche