BackgroundTaskDeferral クラス

定義

名前空間:

Windows.ApplicationModel.Background

IBackgroundTaskInstance.GetDeferral メソッドによって返されるバックグラウンド タスクの遅延を表します。

public ref class BackgroundTaskDeferral sealed

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

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

Public NotInheritable Class BackgroundTaskDeferral

継承

Object Platform::Object IInspectable BackgroundTaskDeferral

属性

ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Windows の要件

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

例

次の例は、バックグラウンド タスクの遅延を使用して、非同期コードの実行中にタスクが途中で終了するのを遅らせる方法を示しています。 すべてのバックグラウンド タスクの遅延が完了していることを確認します。 ほとんどのバックグラウンド タスクにはタイムアウトがあり、その後、保留中の遅延があるかどうかに関係なく、アプリが中断または終了されます。 ただし、未処理のバックグラウンド タスクの遅延を残すことは、プロセスの有効期間をタイムリーに管理するシステムの機能を妨げます。

//
// Declare that your background task's Run method makes asynchronous calls by
// using the async keyword.
//
public async void Run(IBackgroundTaskInstance taskInstance)
{
    //
    // Create the deferral by requesting it from the task instance.
    //
    BackgroundTaskDeferral deferral = taskInstance.GetDeferral();

    //
    // Call asynchronous method(s) using the await keyword.
    //
    var result = await ExampleMethodAsync();

    //
    // Once the asynchronous method(s) are done, close the deferral.
    //
    deferral.Complete();
}

メソッド

Complete()

バックグラウンド タスクに関連付けられた非同期操作が完了したことをシステムに通知します。