AsyncCompletedEventArgs.RaiseExceptionIfNecessary Метод

Определение

Пространство имен:

System.ComponentModel

Сборка:

System.ComponentModel.EventBasedAsync.dll

Исходный код:

AsyncCompletedEvent.cs

Вызывает предоставленное пользователем исключение в случае неудачного выполнения асинхронной операции.

protected:
 void RaiseExceptionIfNecessary();

protected void RaiseExceptionIfNecessary ();

member this.RaiseExceptionIfNecessary : unit -> unit

Protected Sub RaiseExceptionIfNecessary ()

Исключения

InvalidOperationException

Значение свойства Cancelled — true.

TargetInvocationException

Свойство Error было установлено асинхронной операцией. Свойство InnerException содержит ссылку на ошибку Error.

Примеры

В следующем примере кода показано использование RaiseExceptionIfNecessary в свойствах производного класса.

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

Примечания для тех, кто наследует этот метод

Если вы создали собственный AsyncCompletedEventArgs класс из класса , ваши доступные только для чтения свойства должны вызвать RaiseExceptionIfNecessary() метод перед возвратом значения свойства. Если асинхронный рабочий код компонента назначает исключение свойству Error или задает свойству trueзначение Cancelled , свойство вызывает исключение, если клиент пытается прочитать его значение. Это предотвращает доступ клиентов к свойствам, которые потенциально недопустимы из-за сбоя в асинхронной операции.

См. также раздел

• AsyncOperationManager
• AsyncOperation
• Реализация асинхронной модели, основанной на событиях