Freigeben über


BackgroundTaskCompletedEventArgs Klasse

Definition

Stellt Die Vervollständigungsinformationen für einen Vorgang zum Zeitpunkt des Sendens einer Vervollständigungsbenachrichtigung dar.

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
Vererbung
Object Platform::Object IInspectable BackgroundTaskCompletedEventArgs
Attribute

Windows-Anforderungen

Gerätefamilie
Windows 10 (eingeführt in 10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (eingeführt in v1.0)

Beispiele

Im folgenden Beispiel wird gezeigt, wie die BackgroundTaskCompletedEventArgs-Klasse mit einem BackgroundTaskCompletedEventHandler-Delegaten verwendet wird, um den Abschluss von Hintergrundaufgaben zu überwachen, während sich die App im Vordergrund befindet. Beachten Sie, dass dies von der Hintergrundaufgabe abhängt, die status über LocalSettings melden soll.

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

Hinweise

Das System generiert diese Klasse und übergibt sie als Argument an den BackgroundTaskCompletedEventHandler-Handler der Anwendung.

Eigenschaften

InstanceId

Ruft den Bezeichner der Hintergrundaufgabe ab, die für diese Vervollständigung status Benachrichtigung instance.

Methoden

CheckResult()

Löst eine Ausnahme aus, wenn das Ereignis "Abgeschlossene Hintergrundaufgabe" einen Fehler gemeldet hat.

Gilt für: