AsyncCompletedEventArgs Class

Definition

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

다음 코드 예제에서는 AsyncOperation를 사용 하 여 비동기 작업의 수명을 추적 하는 방법을 보여 줍니다.The following code example demonstrates using an AsyncOperation to track the lifetime of asynchronous operations. 이 코드 예제는에 대해 제공 된 큰 예제의 일부는 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

이벤트 기반 비동기 패턴 개요를 구현 하는 클래스를 사용 하는 경우 클래스는 MethodNameCompleted 이벤트를 제공 합니다.If you are using a class that implements the Event-based Asynchronous Pattern Overview, the class will provide a MethodNameCompleted event. System.ComponentModel.AsyncCompletedEventHandler 대리자의 인스턴스를 이벤트에 추가 하면 해당 하는 이벤트 처리기 메서드의 AsyncCompletedEventArgs 매개 변수에 비동기 작업의 결과에 대 한 정보가 표시 됩니다.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.

클라이언트 애플리케이션의 이벤트 처리기 대리자를 확인할 수는 Cancelled 속성을 비동기 작업 취소 되었습니다.The client application's event-handler delegate can check the Cancelled property to determine if the asynchronous task was cancelled.

클라이언트 애플리케이션의 이벤트 처리기 대리자를 확인할 수는 Error 속성을 비동기 작업을 실행 하는 동안 예외가 발생 했는지 확인 합니다.The client application's event-handler delegate can check the Error property to determine if an exception occurred during execution of the asynchronous task.

클래스가 여러 비동기 메서드를 지원 하거나 동일한 비동기 메서드를 여러 번 호출 하는 경우 UserState 속성의 값을 확인 하 여 MethodNameCompleted 이벤트를 발생 시킨 작업을 확인할 수 있습니다.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. 코드의 해당 비동기 작업 시작 및 완료 태스크 Id 라고 하는 해당이 토큰을 추적 해야 합니다.Your code will need to track these tokens, known as task IDs, as their corresponding asynchronous tasks start and complete.

Notes to Inheritors

이벤트 기반 비동기 패턴을 따르는 클래스를 보류 중인 비동기 작업의 상태에 대 한 경고 클라이언트로 이벤트를 발생 시킬 수 있습니다.Classes that follow the Event-based Asynchronous Pattern can raise events to alert clients about the status of pending asynchronous operations. 클래스가 MethodNameCompleted 이벤트를 제공 하는 경우 AsyncCompletedEventArgs를 사용 하 여 비동기 작업의 결과를 클라이언트에 알릴 수 있습니다.If the class provides a MethodNameCompleted event, you can use the AsyncCompletedEventArgs to tell clients about the outcome of asynchronous operations.

비동기 작업의 결과에 대 한 자세한 정보를 클라이언트에 전달 하는 것이 AsyncCompletedEventArgs 허용 하는 것 보다 좋습니다.You may want to communicate to clients more information about the outcome of an asynchronous operation than an AsyncCompletedEventArgs accommodates. 이 경우 AsyncCompletedEventArgs 클래스에서 고유한 클래스를 파생 시키고 추가 전용 인스턴스 변수와 해당 읽기 전용 공용 속성을 제공할 수 있습니다.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. 작업이 취소 되거나 오류가 발생 한 경우 속성 값을 반환 하기 전에 RaiseExceptionIfNecessary() 메서드를 호출 합니다.Call the RaiseExceptionIfNecessary() method before returning the property value, in case the operation was canceled or an error occurred.

Constructors

AsyncCompletedEventArgs() AsyncCompletedEventArgs 클래스의 새 인스턴스를 초기화합니다.Initializes a new instance of the AsyncCompletedEventArgs class.
AsyncCompletedEventArgs(Exception, Boolean, Object) AsyncCompletedEventArgs 클래스의 새 인스턴스를 초기화합니다.Initializes a new instance of the AsyncCompletedEventArgs class.

Properties

Cancelled

비동기 작업 취소 되었는지 여부를 나타내는 값을 가져옵니다.Gets a value indicating whether an asynchronous operation has been canceled.

Error

비동기 작업 중 발생 한 오류를 나타내는 값을 가져옵니다.Gets a value indicating which error occurred during an asynchronous operation.

UserState

비동기 작업에 대 한 고유 식별자를 가져옵니다.Gets the unique identifier for the asynchronous task.

Methods

Equals(Object)

지정한 개체와 현재 개체가 같은지 여부를 확인합니다.Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode()

기본 해시 함수로 작동합니다.Serves as the default hash function.

(Inherited from Object)
GetType()

현재 인스턴스의 Type을 가져옵니다.Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone()

현재 Object의 단순 복사본을 만듭니다.Creates a shallow copy of the current Object.

(Inherited from Object)
RaiseExceptionIfNecessary()

비동기 작업에 실패 한 경우 사용자가 제공한 예외를 발생 시킵니다.Raises a user-supplied exception if an asynchronous operation failed.

ToString()

현재 개체를 나타내는 문자열을 반환합니다.Returns a string that represents the current object.

(Inherited from Object)

Applies to

See also