AsyncCompletedEventArgs Sınıf

Tanım

MethodNameCompleted olayı için veri sağlar.

public ref class AsyncCompletedEventArgs : EventArgs
public class AsyncCompletedEventArgs : EventArgs
type AsyncCompletedEventArgs = class
    inherit EventArgs
Public Class AsyncCompletedEventArgs
Inherits EventArgs
Devralma
AsyncCompletedEventArgs
Türetilmiş

Örnekler

Aşağıdaki kod örneği, zaman uyumsuz işlemlerin ömrünü izlemek için kullanma AsyncOperation işlemini gösterir. Bu kod örneği, sınıfı için System.ComponentModel.AsyncOperationManager sağlanan daha büyük bir örneğin parçasıdır.

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

Açıklamalar

Olay Tabanlı Zaman Uyumsuz Desene Genel Bakış'ı uygulayan bir sınıf kullanıyorsanız, sınıf bir MethodNameCompleted olayı sağlar. Olaya temsilcinin System.ComponentModel.AsyncCompletedEventHandler bir örneğini eklerseniz, karşılık gelen olay işleyici yönteminin parametresinde AsyncCompletedEventArgs zaman uyumsuz işlemlerin sonucu hakkında bilgi alırsınız.

İstemci uygulamanın olay işleyici temsilcisi, zaman uyumsuz görevin iptal edilip iptal edilmediğini belirlemek için özelliğini denetleyebiliyor Cancelled .

İstemci uygulamanın olay işleyici temsilcisi, zaman uyumsuz görevin yürütülmesi sırasında bir özel durumun oluşup oluşmadığını belirlemek için özelliğini denetleyebiliyor Error .

Sınıf birden çok zaman uyumsuz yöntemi veya aynı zaman uyumsuz yönteme yapılan birden çok çağrıyı destekliyorsa, özelliğin değerini UserState denetleyerek MethodNameCompleted olayını hangi görevin tetiklediğini belirleyebilirsiniz. Kodunuzun, karşılık gelen zaman uyumsuz görevleri başlatılır ve tamamlanırken görev kimlikleri olarak bilinen bu belirteçleri izlemesi gerekir.

Devralanlara Notlar

Olay Tabanlı Zaman Uyumsuz Deseni izleyen sınıflar, istemcileri bekleyen zaman uyumsuz işlemlerin durumu hakkında uyarmak için olaylar oluşturabilir. sınıfı bir MethodNameCompleted olayı sağlıyorsa, istemcilere zaman uyumsuz işlemlerin sonucunu bildirmek için öğesini kullanabilirsiniz AsyncCompletedEventArgs .

İstemcilere zaman uyumsuz bir işlemin sonucu hakkında, uygun olandan AsyncCompletedEventArgs daha fazla bilgi vermek isteyebilirsiniz. Bu durumda, sınıfından AsyncCompletedEventArgs kendi sınıfınızı türetebilir ve ek özel örnek değişkenleri ve karşılık gelen salt okunur genel özellikler sağlayabilirsiniz. İşlemin RaiseExceptionIfNecessary() iptal edilmiş olması veya bir hata olması durumunda özellik değerini döndürmeden önce yöntemini çağırın.

Oluşturucular

AsyncCompletedEventArgs()
Geçersiz.

AsyncCompletedEventArgs sınıfının yeni bir örneğini başlatır.

AsyncCompletedEventArgs(Exception, Boolean, Object)

AsyncCompletedEventArgs sınıfının yeni bir örneğini başlatır.

Özellikler

Cancelled

Zaman uyumsuz işlemin iptal edilip edilmediğini belirten bir değer alır.

Error

Zaman uyumsuz bir işlem sırasında hangi hatanın oluştuğunu belirten bir değer alır.

UserState

Zaman uyumsuz görevin benzersiz tanımlayıcısını alır.

Yöntemler

Equals(Object)

Belirtilen nesnenin geçerli nesneye eşit olup olmadığını belirler.

(Devralındığı yer: Object)
GetHashCode()

Varsayılan karma işlevi işlevi görür.

(Devralındığı yer: Object)
GetType()

Type Geçerli örneğini alır.

(Devralındığı yer: Object)
MemberwiseClone()

Geçerli Objectöğesinin sığ bir kopyasını oluşturur.

(Devralındığı yer: Object)
RaiseExceptionIfNecessary()

Zaman uyumsuz bir işlem başarısız olursa kullanıcı tarafından sağlanan bir özel durum oluşturur.

ToString()

Geçerli nesneyi temsil eden dizeyi döndürür.

(Devralındığı yer: Object)

Şunlara uygulanır

Ayrıca bkz.