AsyncCompletedEventArgs.RaiseExceptionIfNecessary Méthode

Définition

Espace de noms:
System.ComponentModel
Assemblys:
System.dll, System.ComponentModel.EventBasedAsync.dll
Assembly:
System.dll
Assembly:
netstandard.dll

Déclenche une exception fournie par l’utilisateur si une opération asynchrone a échoué.

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

Exceptions

InvalidOperationException

La Cancelled propriété est true.

TargetInvocationException

La Error propriété a été définie par l’opération asynchrone. La InnerException propriété contient une référence à Error.

Exemples

L’exemple de code suivant illustre l’utilisation RaiseExceptionIfNecessary dans les propriétés de classe dérivées.

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

    public CalculatePrimeCompletedEventArgs(
        int numberToTest,
        int firstDivisor,
        bool isPrime,
        Exception e,
        bool canceled,
        object state) : base(e, canceled, state)
    {
        numberToTestValue = numberToTest;
        firstDivisorValue = firstDivisor;
        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

Notes pour les héritiers

Si vous avez dérivé votre propre classe de la AsyncCompletedEventArgs classe, vos propriétés en lecture seule doivent appeler la RaiseExceptionIfNecessary() méthode avant de renvoyer la valeur de propriété. Si le code worker asynchrone du composant affecte une exception à la Error propriété ou définit la Cancelled propriété sur , la propriété truedéclenche une exception si un client tente de lire sa valeur. Cela empêche les clients d’accéder aux propriétés potentiellement non valides en raison d’un échec dans l’opération asynchrone.

S’applique à

Voir aussi