AsyncCompletedEventArgs.UserState Tulajdonság

Definíció

Névtér:
System.ComponentModel
Szerelvények:
System.dll, System.ComponentModel.EventBasedAsync.dll
Szerelvény:
System.dll
Szerelvény:
netstandard.dll

Lekéri az aszinkron tevékenység egyedi azonosítót.

public:
 property System::Object ^ UserState { System::Object ^ get(); };
public object UserState { get; }
member this.UserState : obj
Public ReadOnly Property UserState As Object

Tulajdonság értéke

Object

Objektumhivatkozás, amely egyedileg azonosítja az aszinkron feladatot; ellenkező esetben, null ha nincs beállítva érték.

Példák

Az alábbi példakód egy aszinkron AsyncOperation műveletek élettartamának nyomon követésére szolgál. Ez a példakód egy nagyobb, az System.ComponentModel.AsyncOperationManager osztályhoz tartozó példa része.

using System;
using System.Collections;
using System.Collections.Specialized;
using System.ComponentModel;
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.
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

Megjegyzések

Ha egy osztály több aszinkron metódust vagy egy metódus több meghívását is támogatja, a tulajdonság értékének UserState ellenőrzésével meghatározhatja, hogy melyik tevékenység okozta a MethodNameCompleted eseményt. A kódnak nyomon kell követnie ezeket a jogkivonatokat, más néven feladatazonosítókat, mivel a megfelelő aszinkron tevékenységek elkezdődnek és befejeződnek.

Ennek a tulajdonságnak az értéke az aszinkron metódus eredeti hívása során van beállítva, amely elindította a feladatot.

A következőre érvényes:

Lásd még