Cet article a fait l’objet d’une traduction automatique. Pour afficher l’article en anglais, activez la case d’option Anglais. Vous pouvez également afficher le texte anglais dans une fenêtre contextuelle en faisant glisser le pointeur de la souris sur le texte traduit.
Traduction
Anglais

AsyncCompletedEventArgs classe

 

Date de publication : novembre 2016

Fournit des données pour le MethodNameCompleted événement.

Espace de noms:   System.ComponentModel
Assembly:  System (dans System.dll)

System.Object
  System.EventArgs
    System.ComponentModel.AsyncCompletedEventArgs
      System.Activities.InvokeCompletedEventArgs
      System.ComponentModel.RunWorkerCompletedEventArgs
      System.Deployment.Application.CheckForUpdateCompletedEventArgs
      System.Deployment.Application.DownloadApplicationCompletedEventArgs
      System.Deployment.Application.DownloadFileGroupCompletedEventArgs
      System.Deployment.Application.GetManifestCompletedEventArgs
      System.Device.Location.ResolveAddressCompletedEventArgs
      System.Net.DownloadDataCompletedEventArgs
      System.Net.DownloadStringCompletedEventArgs
      System.Net.NetworkInformation.PingCompletedEventArgs
      System.Net.OpenReadCompletedEventArgs
      System.Net.OpenWriteCompletedEventArgs
      System.Net.PeerToPeer.Collaboration.CreateContactCompletedEventArgs
      System.Net.PeerToPeer.Collaboration.InviteCompletedEventArgs
      System.Net.PeerToPeer.Collaboration.RefreshDataCompletedEventArgs
      System.Net.PeerToPeer.Collaboration.SubscribeCompletedEventArgs
      System.Net.PeerToPeer.ResolveCompletedEventArgs
      System.Net.UploadDataCompletedEventArgs
      System.Net.UploadFileCompletedEventArgs
      System.Net.UploadStringCompletedEventArgs
      System.Net.UploadValuesCompletedEventArgs
      System.ServiceModel.ClientBase<TChannel>.InvokeAsyncCompletedEventArgs
      System.ServiceModel.Discovery.FindCompletedEventArgs
      System.ServiceModel.Discovery.ResolveCompletedEventArgs
      System.Speech.Recognition.EmulateRecognizeCompletedEventArgs
      System.Speech.Recognition.LoadGrammarCompletedEventArgs
      System.Speech.Recognition.RecognizeCompletedEventArgs
      System.Speech.Synthesis.PromptEventArgs
      System.Web.Services.Protocols.InvokeCompletedEventArgs
      System.Windows.Documents.GetPageCompletedEventArgs
      System.Windows.Documents.GetPageNumberCompletedEventArgs
      System.Windows.Documents.GetPageRootCompletedEventArgs
      System.Windows.Documents.Serialization.WritingCompletedEventArgs
      System.Windows.Xps.Serialization.XpsSerializationCompletedEventArgs

[HostProtectionAttribute(SecurityAction.LinkDemand, SharedState = true)]
public class AsyncCompletedEventArgs : EventArgs

NomDescription
System_CAPS_pubmethodAsyncCompletedEventArgs()

Obsolète.Initialise une nouvelle instance de la classe AsyncCompletedEventArgs.

System_CAPS_pubmethodAsyncCompletedEventArgs(Exception, Boolean, Object)

Initialise une nouvelle instance de la classe AsyncCompletedEventArgs.

NomDescription
System_CAPS_pubpropertyCancelled

Obtient une valeur indiquant si une opération asynchrone a été annulée.

System_CAPS_pubpropertyError

Obtient une valeur qui indique l’erreur qui s’est produite pendant une opération asynchrone.

System_CAPS_pubpropertyUserState

Obtient l’identificateur unique de la tâche asynchrone.

NomDescription
System_CAPS_pubmethodEquals(Object)

Détermine si l'objet spécifié est identique à l'objet actuel.(Hérité de Object.)

System_CAPS_protmethodFinalize()

Autorise un objet à tenter de libérer des ressources et d'exécuter d'autres opérations de nettoyage avant qu'il ne soit récupéré par l'opération garbage collection. (Hérité de Object.)

System_CAPS_pubmethodGetHashCode()

Fait office de fonction de hachage par défaut.(Hérité de Object.)

System_CAPS_pubmethodGetType()

Obtient le Type de l'instance actuelle.(Hérité de Object.)

System_CAPS_protmethodMemberwiseClone()

Crée une copie superficielle du Object actuel.(Hérité de Object.)

System_CAPS_protmethodRaiseExceptionIfNecessary()

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

System_CAPS_pubmethodToString()

Retourne une chaîne qui représente l'objet actuel.(Hérité de Object.)

Si vous utilisez une classe qui implémente le Event-based Asynchronous Pattern Overview, la classe fournit un MethodNameCompleted événement. Si vous ajoutez une instance de la System.ComponentModel.AsyncCompletedEventHandler délégué à l’événement, vous recevrez des informations sur le résultat des opérations asynchrones dans le AsyncCompletedEventArgs paramètre de la méthode de gestionnaire d’événements correspondant.

Délégué de gestionnaire d’événements de l’application cliente peut vérifier la Cancelled propriété pour déterminer si la tâche asynchrone a été annulée.

Délégué de gestionnaire d’événements de l’application cliente peut vérifier la Error propriété pour déterminer si une exception s’est produite lors de l’exécution de la tâche asynchrone.

Si la classe prend en charge plusieurs méthodes asynchrones ou plusieurs appels à la même méthode asynchrone, vous pouvez déterminer quelle tâche a déclenché le MethodNameCompleted événement en vérifiant la valeur de la UserState propriété. Votre code devra suivre ces jetons, également appelés identificateurs de tâche, lorsque leurs tâches asynchrones correspondantes démarrent et se terminent.

Remarques à l’attention des héritiers :

Les classes qui suivent le modèle asynchrone basé sur événement peuvent déclencher des événements pour alerter des clients sur l’état des opérations asynchrones en attente. Si la classe fournit un MethodNameCompleted événement, vous pouvez utiliser la AsyncCompletedEventArgs pour informer les clients du résultat des opérations asynchrones.

Vous souhaiterez peut-être communiquer aux clients plus d’informations sur le résultat d’une opération asynchrone qu’un AsyncCompletedEventArgs prend en charge. Dans ce cas, vous pouvez dériver votre propre classe de la AsyncCompletedEventArgs classe et fournir des variables d’instance privées supplémentaires et des propriétés publiques en lecture seule correspondantes. Appelez le RaiseExceptionIfNecessary méthode avant de retourner la valeur de propriété, au cas où l’opération a été annulée ou une erreur s’est produite.

L’exemple de code suivant montre comment utiliser un AsyncOperation pour effectuer le suivi de la durée de vie des opérations asynchrones. Cet exemple de code fait partie d’un exemple plus complet fourni pour la System.ComponentModel.AsyncOperationManager classe.

using System;
using System.Collections;
using System.Collections.Specialized;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Globalization;
using System.Threading;
using System.Windows.Forms;
// This event handler updates the ListView control when the
// PrimeNumberCalculator raises the CalculatePrimeCompleted
// event. The ListView item is updated with the appropriate
// outcome of the calculation: Canceled, Error, or result.
private void primeNumberCalculator1_CalculatePrimeCompleted(
    object sender, 
    CalculatePrimeCompletedEventArgs e)
{
    Guid taskId = (Guid)e.UserState;

    if (e.Cancelled)
    {   
        string result = "Canceled";

        ListViewItem lvi = UpdateListViewItem(taskId, result);

        if (lvi != null)
        {
            lvi.BackColor = Color.Pink;
            lvi.Tag = null;
        }
    }
    else if (e.Error != null)
    {
        string result = "Error";

        ListViewItem lvi = UpdateListViewItem(taskId, result);

        if (lvi != null)
        {
            lvi.BackColor = Color.Red;
            lvi.ForeColor = Color.White;
            lvi.Tag = null;
        }
    }
    else
    {   
        bool result = e.IsPrime;

        ListViewItem lvi = UpdateListViewItem(
            taskId, 
            result, 
            e.FirstDivisor);

        if (lvi != null)
        {
            lvi.BackColor = Color.LightGray;
            lvi.Tag = null;
        }
    }
}

Plateforme Windows universelle
Disponible depuis 8
.NET Framework
Disponible depuis 2.0
Bibliothèque de classes portable
Pris en charge dans : plateformes .NET portables
Silverlight
Disponible depuis 2.0
Silverlight pour Windows Phone
Disponible depuis 7.0
Windows Phone
Disponible depuis 8.1

Tous les membres statiques publics ( Shared en Visual Basic) de ce type sont thread-safe. Les membres d’instance n’ont pas la garantie d’être thread-safe.

Retour au début
Afficher: