BackgroundTaskCompletedEventArgs クラス

リファレンス

定義

名前空間:: Windows.ApplicationModel.Background

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

編集

完了通知が送信された時点でのタスクの完了情報を表します。

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

継承: Object Platform::Object IInspectable BackgroundTaskCompletedEventArgs

属性: ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Windows の要件

デバイスファミリ	Windows 10 (10.0.10240.0 で導入)
API contract	Windows.Foundation.UniversalApiContract (v1.0 で導入)

例

次の例では、BackgroundTaskCompletedEventArgs クラスと BackgroundTaskCompletedEventHandler デリゲートを使用して、アプリがフォアグラウンドにある間にバックグラウンドタスクの完了を監視する方法を示します。これは、 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;
    });
}

注釈

システムはこのクラスを生成し、アプリケーションの BackgroundTaskCompletedEventHandler ハンドラーに引数として渡します。

プロパティ

InstanceId

この完了状態通知のバックグラウンドタスクインスタンスの識別子を取得します。

メソッド

CheckResult()

バックグラウンドタスクの完了イベントでエラーが報告された場合は、例外をスローします。

適用対象