BackgroundTaskCompletedEventArgs Classe

Définition

Espace de noms:

Windows.ApplicationModel.Background

Représente les informations d’achèvement d’une tâche au moment de l’envoi d’une notification d’achèvement.

public ref class BackgroundTaskCompletedEventArgs sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class BackgroundTaskCompletedEventArgs final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class BackgroundTaskCompletedEventArgs

Public NotInheritable Class BackgroundTaskCompletedEventArgs

Héritage

Object Platform::Object IInspectable BackgroundTaskCompletedEventArgs

Attributs

ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Configuration requise pour Windows

Famille d’appareils	Windows 10 (introduit dans 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (introduit dans v1.0)

Exemples

L’exemple suivant montre comment utiliser la classe BackgroundTaskCompletedEventArgs avec un délégué BackgroundTaskCompletedEventHandler pour surveiller l’achèvement des tâches en arrière-plan pendant que l’application se trouve au premier plan. Notez que cela dépend de la tâche en arrière-plan à signaler status via LocalSettings.

private async void OnCompleted(IBackgroundTaskRegistration task,
                               BackgroundTaskCompletedEventArgs args)
{
    var settings = ApplicationData.Current.LocalSettings;
    var key = task.TaskId.ToString();
    string status = settings.Values[key].ToString();

    //
    // UI element updates should be done asynchronously.
    //
    await Dispatcher.RunAsync(CoreDispatcherPriority.Normal,
    () =>
    {
        ExampleProgressElement.Text = "Task completed with status: " + status;
    });
}

Remarques

Le système génère cette classe et la transmet en tant qu’argument au gestionnaire BackgroundTaskCompletedEventHandler de l’application.

Propriétés

InstanceId

Obtient l’identificateur de la tâche en arrière-plan instance pour cette notification d’achèvement status.

Méthodes

CheckResult()

Lève une exception si l’événement de fin de tâche en arrière-plan a signalé une erreur.