AsyncCompletedEventArgs.UserState Özellik

Tanım

Ad Alanı:

System.ComponentModel

Bütünleştirilmiş Kod:

System.ComponentModel.EventBasedAsync.dll

Kaynak:

AsyncCompletedEvent.cs

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

public:
 property System::Object ^ UserState { System::Object ^ get(); };

public object? UserState { get; }

member this.UserState : obj

Public ReadOnly Property UserState As Object

Özellik Değeri

Object

Zaman uyumsuz görevi benzersiz olarak tanımlayan bir nesne başvurusu; aksi takdirde, null hiçbir değer ayarlanmamışsa.

Ö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

Bir sınıf birden çok zaman uyumsuz yöntemi veya tek bir yöntemin birden çok çağrısını destekliyorsa, özelliğinin değerini UserState denetleyerek MethodNameCompleted olayını hangi görevin tetiklediğini belirleyebilirsiniz. Kodunuz, karşılık gelen zaman uyumsuz görevlerin başlatılıp tamamlanması için görev kimlikleri olarak bilinen bu belirteçleri izlemeniz gerekir.

Bu özelliğin değeri, görevi başlatan zaman uyumsuz yönteme yapılan özgün çağrı sırasında ayarlanır.

Ayrıca bkz.

• AsyncCompletedEventHandler
• AsyncOperationManager
• AsyncOperation
• Olay Tabanlı Zaman Uyumsuz Deseni Uygulama