AsyncCompletedEventArgs.RaiseExceptionIfNecessary Méthode

Définition

Espace de noms:

System.ComponentModel

Assembly:

System.ComponentModel.EventBasedAsync.dll

Source:

AsyncCompletedEvent.cs

Lève une exception fournie par l'utilisateur en cas d'échec d'une opération asynchrone.

C#

protected void RaiseExceptionIfNecessary ();

Exceptions

InvalidOperationException

La propriété Cancelled a la valeur true.

TargetInvocationException

La propriété Error a été définie par l'opération asynchrone. La propriété InnerException 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.

C#

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;
        }
    }
}

Notes pour les héritiers

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

S’applique à

Voir aussi

• AsyncOperationManager
• AsyncOperation
• Implémentation du modèle asynchrone basé sur des événements