AsyncCompletedEventArgs.RaiseExceptionIfNecessary Metoda

Odwołanie

Definicja

Przestrzeń nazw:: System.ComponentModel

Zestaw:: System.ComponentModel.EventBasedAsync.dll

Zestaw:: System.dll

Zestaw:: netstandard.dll

Źródło:: AsyncCompletedEvent.cs

Źródło:: AsyncCompletedEvent.cs

Źródło:: AsyncCompletedEvent.cs

Ważne

Niektóre informacje odnoszą się do produktu w wersji wstępnej, który może zostać znacząco zmodyfikowany przed wydaniem. Firma Microsoft nie udziela żadnych gwarancji, jawnych lub domniemanych, w odniesieniu do informacji podanych w tym miejscu.

Zgłasza wyjątek dostarczony przez użytkownika, jeśli operacja asynchroniczna nie powiodła się.

protected:
 void RaiseExceptionIfNecessary();

protected void RaiseExceptionIfNecessary ();

member this.RaiseExceptionIfNecessary : unit -> unit

Protected Sub RaiseExceptionIfNecessary ()

Wyjątki

InvalidOperationException

Właściwość Cancelled to true.

TargetInvocationException

Właściwość Error została ustawiona przez operację asynchroniczną. Właściwość InnerException zawiera odwołanie do Errorelementu .

Przykłady

Poniższy przykład kodu pokazuje użycie RaiseExceptionIfNecessary we właściwościach klasy pochodnej.

public class CalculatePrimeCompletedEventArgs :
    AsyncCompletedEventArgs
{
    private int numberToTestValue = 0;
    private int firstDivisorValue = 1;
    private bool isPrimeValue;

    public CalculatePrimeCompletedEventArgs(
        int numberToTest,
        int firstDivisor,
        bool isPrime,
        Exception e,
        bool canceled,
        object state) : base(e, canceled, state)
    {
        this.numberToTestValue = numberToTest;
        this.firstDivisorValue = firstDivisor;
        this.isPrimeValue = isPrime;
    }

    public int NumberToTest
    {
        get
        {
            // Raise an exception if the operation failed or 
            // was canceled.
            RaiseExceptionIfNecessary();

            // If the operation was successful, return the 
            // property value.
            return numberToTestValue;
        }
    }

    public int FirstDivisor
    {
        get
        {
            // Raise an exception if the operation failed or 
            // was canceled.
            RaiseExceptionIfNecessary();

            // If the operation was successful, return the 
            // property value.
            return firstDivisorValue;
        }
    }

    public bool IsPrime
    {
        get
        {
            // Raise an exception if the operation failed or 
            // was canceled.
            RaiseExceptionIfNecessary();

            // If the operation was successful, return the 
            // property value.
            return isPrimeValue;
        }
    }
}

Public Class CalculatePrimeCompletedEventArgs
    Inherits AsyncCompletedEventArgs
    Private numberToTestValue As Integer = 0
    Private firstDivisorValue As Integer = 1
    Private isPrimeValue As Boolean


    Public Sub New( _
    ByVal numberToTest As Integer, _
    ByVal firstDivisor As Integer, _
    ByVal isPrime As Boolean, _
    ByVal e As Exception, _
    ByVal canceled As Boolean, _
    ByVal state As Object)

        MyBase.New(e, canceled, state)
        Me.numberToTestValue = numberToTest
        Me.firstDivisorValue = firstDivisor
        Me.isPrimeValue = isPrime

    End Sub


    Public ReadOnly Property NumberToTest() As Integer
        Get
            ' Raise an exception if the operation failed 
            ' or was canceled.
            RaiseExceptionIfNecessary()

            ' If the operation was successful, return 
            ' the property value.
            Return numberToTestValue
        End Get
    End Property


    Public ReadOnly Property FirstDivisor() As Integer
        Get
            ' Raise an exception if the operation failed 
            ' or was canceled.
            RaiseExceptionIfNecessary()

            ' If the operation was successful, return 
            ' the property value.
            Return firstDivisorValue
        End Get
    End Property


    Public ReadOnly Property IsPrime() As Boolean
        Get
            ' Raise an exception if the operation failed 
            ' or was canceled.
            RaiseExceptionIfNecessary()

            ' If the operation was successful, return 
            ' the property value.
            Return isPrimeValue
        End Get
    End Property
End Class

Uwagi dotyczące dziedziczenia

Jeśli utworzono własną klasę z AsyncCompletedEventArgs klasy, właściwości tylko do odczytu powinny wywołać metodę RaiseExceptionIfNecessary() przed zwróceniem wartości właściwości. Jeśli asynchroniczny kod procesu roboczego składnika przypisuje wyjątek do Error właściwości lub ustawia Cancelled właściwość na true, właściwość zgłosi wyjątek, jeśli klient spróbuje odczytać jego wartość. Uniemożliwia to klientom uzyskiwanie dostępu do właściwości, które są potencjalnie nieprawidłowe z powodu awarii operacji asynchronicznej.

Dotyczy

Produkt	Wersje
.NET	Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework	2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard	2.0, 2.1
UWP	10.0

Udostępnij za pośrednictwem