AsyncCompletedEventArgs.RaiseExceptionIfNecessary Método

Definición

Espacio de nombres:

System.ComponentModel

Ensamblado:

System.ComponentModel.EventBasedAsync.dll

Source:

AsyncCompletedEvent.cs

Genera una excepción proporcionada por el usuario si se ha producido un error en una operación asincrónica.

C#

protected void RaiseExceptionIfNecessary ();

Excepciones

InvalidOperationException

La propiedad Cancelled es true.

TargetInvocationException

La operación asincrónica ha establecido la propiedad Error. La propiedad InnerException contiene una referencia a Error.

Ejemplos

En el ejemplo de código siguiente se muestra el uso RaiseExceptionIfNecessary de en propiedades de clase derivadas.

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

Notas a los desarrolladores de herederos

Si ha derivado su propia clase de la AsyncCompletedEventArgs clase , las propiedades de solo lectura deben llamar al RaiseExceptionIfNecessary() método antes de devolver el valor de propiedad. Si el código de trabajo asincrónico del componente asigna una excepción a la Error propiedad o establece la Cancelled propiedad trueen , la propiedad generará una excepción si un cliente intenta leer su valor. Esto impide que los clientes accedan a las propiedades que potencialmente no son válidas debido a un error en la operación asincrónica.

Se aplica a

Consulte también

• AsyncOperationManager
• AsyncOperation
• Implementación del modelo asincrónico basado en eventos