AsyncCompletedEventArgs.RaiseExceptionIfNecessary Metoda

  • Reference

Definice

Obor názvů:
System.ComponentModel
Sestavení:
System.ComponentModel.EventBasedAsync.dll
Sestavení:
System.dll
Sestavení:
netstandard.dll
Zdroj:
AsyncCompletedEvent.cs
Zdroj:
AsyncCompletedEvent.cs
Zdroj:
AsyncCompletedEvent.cs

Vyvolá výjimku zadanou uživatelem, pokud asynchronní operace selhala.

protected:
 void RaiseExceptionIfNecessary();
protected void RaiseExceptionIfNecessary ();
member this.RaiseExceptionIfNecessary : unit -> unit
Protected Sub RaiseExceptionIfNecessary ()

Výjimky

InvalidOperationException

Vlastnost Cancelled je true.

TargetInvocationException

Vlastnost Error byla nastavena asynchronní operací. Vlastnost InnerException obsahuje odkaz na Error.

Příklady

Následující příklad kódu ukazuje použití RaiseExceptionIfNecessary v odvozených vlastnostech třídy.

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

Poznámky pro dědice

Pokud jste odvodili vlastní třídu z AsyncCompletedEventArgs třídy, vlastnosti jen pro čtení by měly volat metodu RaiseExceptionIfNecessary() před vrácením hodnoty vlastnosti. Pokud asynchronní pracovní kód komponenty přiřadí výjimku Error vlastnosti nebo nastaví Cancelled vlastnost na true, vlastnost vyvolá výjimku, pokud se klient pokusí přečíst její hodnotu. To zabraňuje klientům v přístupu k vlastnostem, které jsou potenciálně neplatné z důvodu selhání asynchronní operace.

Platí pro

Viz také