AsyncCompletedEventArgs.RaiseExceptionIfNecessary メソッド

  • リファレンス

定義

名前空間:
System.ComponentModel
アセンブリ:
System.ComponentModel.EventBasedAsync.dll
アセンブリ:
System.dll
アセンブリ:
netstandard.dll
ソース:
AsyncCompletedEvent.cs
ソース:
AsyncCompletedEvent.cs
ソース:
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() メソッドを呼び出す必要があります。 コンポーネントの非同期ワーカー コードが プロパティに例外を割り当てたり、 プロパティを Cancelled にErrortrue設定したりする場合、クライアントがその値を読み取ろうとすると、 プロパティによって例外が発生します。 これにより、非同期操作でエラーが発生したために無効になる可能性があるプロパティにクライアントがアクセスできなくなります。

適用対象

こちらもご覧ください