次の方法で共有


BackgroundTaskCompletedEventArgs クラス

定義

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

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
属性

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()

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

適用対象