バックグラウンドタスクの進行状況と完了を監視する

2025-06-10

重要な API

アウトプロセスで実行されるバックグラウンドタスクによって報告された進行状況と完了をアプリで認識する方法について説明します。 (インプロセスバックグラウンドタスクの場合は、進行状況と完了を示す共有変数を設定できます)。

バックグラウンドタスクの進行状況と完了は、アプリコードで監視できます。これを行うために、アプリはシステムに登録したバックグラウンドタスクのイベントをサブスクライブします。

このトピックでは、バックグラウンドタスクを登録するアプリがあることを前提としています。バックグラウンドタスクの作成をすぐに開始するには、「インプロセスバックグラウンドタスクの作成と登録」を参照するか、「アウトプロセスバックグラウンドタスクを作成して登録する」。条件とトリガーの詳細については、「バックグラウンドタスクでのアプリのサポート」を参照してください。

完了したバックグラウンドタスクを処理するイベントハンドラーを作成する

手順 1

完了したバックグラウンドタスクを処理するイベントハンドラー関数を作成します。このコードは、IBackgroundTaskRegistration オブジェクトと BackgroundTaskCompletedEventArgs オブジェクトを受け取る特定のフットプリントに従う必要があります。

OnCompleted バックグラウンドタスクイベントハンドラーメソッドには、次のフットプリントを使用します。

private void OnCompleted(IBackgroundTaskRegistration task, BackgroundTaskCompletedEventArgs args)
{
    // TODO: Add code that deals with background task completion.
}

auto completed{ [this](
        Windows::ApplicationModel::Background::BackgroundTaskRegistration const& /* sender */,
        Windows::ApplicationModel::Background::BackgroundTaskCompletedEventArgs const& /* args */)
{
    // TODO: Add code that deals with background task completion.
} };

auto completed = [this](BackgroundTaskRegistration^ task, BackgroundTaskCompletedEventArgs^ args)
{
    // TODO: Add code that deals with background task completion.
};

手順 2

バックグラウンドタスクの完了を処理するコードをイベントハンドラーに追加します。

たとえば、バックグラウンドタスクのサンプルは UI を更新します。

private void OnCompleted(IBackgroundTaskRegistration task, BackgroundTaskCompletedEventArgs args)
{
    UpdateUI();
}

auto completed{ [this](
        Windows::ApplicationModel::Background::BackgroundTaskRegistration const& /* sender */,
        Windows::ApplicationModel::Background::BackgroundTaskCompletedEventArgs const& /* args */)
{
    UpdateUI();
} };

auto completed = [this](BackgroundTaskRegistration^ task, BackgroundTaskCompletedEventArgs^ args)
{    
    UpdateUI();
};

バックグラウンドタスクの進行状況を処理するイベントハンドラー関数を作成する

手順 1

完了したバックグラウンドタスクを処理するイベントハンドラー関数を作成します。このコードは、IBackgroundTaskRegistration オブジェクトと BackgroundTaskProgressEventArgs オブジェクトを取り込む特定のフットプリントに従う必要があります。

OnProgress バックグラウンドタスクイベントハンドラーメソッドには、次のフットプリントを使用します。

private void OnProgress(IBackgroundTaskRegistration task, BackgroundTaskProgressEventArgs args)
{
    // TODO: Add code that deals with background task progress.
}

auto progress{ [this](
    Windows::ApplicationModel::Background::BackgroundTaskRegistration const& /* sender */,
    Windows::ApplicationModel::Background::BackgroundTaskProgressEventArgs const& /* args */)
{
    // TODO: Add code that deals with background task progress.
} };

auto progress = [this](BackgroundTaskRegistration^ task, BackgroundTaskProgressEventArgs^ args)
{
    // TODO: Add code that deals with background task progress.
};

手順 2

バックグラウンドタスクの完了を処理するコードをイベントハンドラーに追加します。

たとえば、バックグラウンドタスクのサンプルは、args パラメーターを介して渡された進行状況で UI を更新します。

private void OnProgress(IBackgroundTaskRegistration task, BackgroundTaskProgressEventArgs args)
{
    var progress = "Progress: " + args.Progress + "%";
    BackgroundTaskSample.SampleBackgroundTaskProgress = progress;
    UpdateUI();
}

auto progress{ [this](
    Windows::ApplicationModel::Background::BackgroundTaskRegistration const& /* sender */,
    Windows::ApplicationModel::Background::BackgroundTaskProgressEventArgs const& args)
{
    winrt::hstring progress{ L"Progress: " + winrt::to_hstring(args.Progress()) + L"%" };
    BackgroundTaskSample::SampleBackgroundTaskProgress = progress;
    UpdateUI();
} };

auto progress = [this](BackgroundTaskRegistration^ task, BackgroundTaskProgressEventArgs^ args)
{
    auto progress = "Progress: " + args->Progress + "%";
    BackgroundTaskSample::SampleBackgroundTaskProgress = progress;
    UpdateUI();
};

イベントハンドラー関数を新規および既存のバックグラウンドタスクに登録する

手順 1

アプリが初めてバックグラウンドタスクを登録するときは、アプリがまだフォアグラウンドでアクティブな状態でタスクが実行されている場合に備えて、進行状況と完了の更新を受け取るために登録する必要があります。

たとえば、バックグラウンドタスクのサンプルは、登録する各バックグラウンドタスクで次の関数を呼び出します。

private void AttachProgressAndCompletedHandlers(IBackgroundTaskRegistration task)
{
    task.Progress += new BackgroundTaskProgressEventHandler(OnProgress);
    task.Completed += new BackgroundTaskCompletedEventHandler(OnCompleted);
}

void SampleBackgroundTask::AttachProgressAndCompletedHandlers(Windows::ApplicationModel::Background::IBackgroundTaskRegistration const& task)
{
    auto progress{ [this](
        Windows::ApplicationModel::Background::BackgroundTaskRegistration const& /* sender */,
        Windows::ApplicationModel::Background::BackgroundTaskProgressEventArgs const& args)
    {
        winrt::hstring progress{ L"Progress: " + winrt::to_hstring(args.Progress()) + L"%" };
        BackgroundTaskSample::SampleBackgroundTaskProgress = progress;
        UpdateUI();
    } };

    task.Progress(progress);

    auto completed{ [this](
        Windows::ApplicationModel::Background::BackgroundTaskRegistration const& /* sender */,
        Windows::ApplicationModel::Background::BackgroundTaskCompletedEventArgs const& /* args */)
    {
        UpdateUI();
    } };

    task.Completed(completed);
}

void SampleBackgroundTask::AttachProgressAndCompletedHandlers(IBackgroundTaskRegistration^ task)
{
    auto progress = [this](BackgroundTaskRegistration^ task, BackgroundTaskProgressEventArgs^ args)
    {
        auto progress = "Progress: " + args->Progress + "%";
        BackgroundTaskSample::SampleBackgroundTaskProgress = progress;
        UpdateUI();
    };

    task->Progress += ref new BackgroundTaskProgressEventHandler(progress);

    auto completed = [this](BackgroundTaskRegistration^ task, BackgroundTaskCompletedEventArgs^ args)
    {
        UpdateUI();
    };

    task->Completed += ref new BackgroundTaskCompletedEventHandler(completed);
}

手順 2

アプリが起動するか、バックグラウンドタスクの状態が関連する新しいページに移動すると、現在登録されているバックグラウンドタスクの一覧を取得し、進行状況と完了イベントハンドラー関数に関連付ける必要があります。アプリケーションによって現在登録されているバックグラウンドタスクの一覧は、BackgroundTaskRegistrationのAllTasks プロパティに保持されます。

たとえば、バックグラウンドタスクのサンプルでは、SampleBackgroundTask ページが移動したときに、次のコードを使用してイベントハンドラーをアタッチします。

protected override void OnNavigatedTo(NavigationEventArgs e)
{
    foreach (var task in BackgroundTaskRegistration.AllTasks)
    {
        if (task.Value.Name == BackgroundTaskSample.SampleBackgroundTaskName)
        {
            AttachProgressAndCompletedHandlers(task.Value);
            BackgroundTaskSample.UpdateBackgroundTaskStatus(BackgroundTaskSample.SampleBackgroundTaskName, true);
        }
    }

    UpdateUI();
}

void SampleBackgroundTask::OnNavigatedTo(Windows::UI::Xaml::Navigation::NavigationEventArgs const& /* e */)
{
    // A pointer back to the main page. This is needed if you want to call methods in MainPage such
    // as NotifyUser().
    m_rootPage = MainPage::Current;

    // Attach progress and completed handlers to any existing tasks.
    auto allTasks{ Windows::ApplicationModel::Background::BackgroundTaskRegistration::AllTasks() };

    for (auto const& task : allTasks)
    {
        if (task.Value().Name() == SampleBackgroundTaskName)
        {
            AttachProgressAndCompletedHandlers(task.Value());
            break;
        }
    }

    UpdateUI();
}

void SampleBackgroundTask::OnNavigatedTo(NavigationEventArgs^ e)
{
    // A pointer back to the main page.  This is needed if you want to call methods in MainPage such
    // as NotifyUser().
    rootPage = MainPage::Current;

    // Attach progress and completed handlers to any existing tasks.
    auto iter = BackgroundTaskRegistration::AllTasks->First();
    auto hascur = iter->HasCurrent;
    while (hascur)
    {
        auto cur = iter->Current->Value;

        if (cur->Name == SampleBackgroundTaskName)
        {
            AttachProgressAndCompletedHandlers(cur);
            break;
        }

        hascur = iter->MoveNext();
    }

    UpdateUI();
}

インプロセスバックグラウンドタスクを作成して登録します。
プロセス外のバックグラウンドタスクを作成して登録
アプリケーションマニフェストでバックグラウンドタスクを宣言する
取り消されたバックグラウンドタスクのを処理する
バックグラウンドタスクを登録する
バックグラウンドタスクを使用してシステムイベントに応答
バックグラウンドタスクを実行するための条件を設定する
バックグラウンドタスクからライブタイルを更新
メンテナンストリガーを使用する
タイマーでバックグラウンドタスクを実行する
バックグラウンドタスクのガイドライン
バックグラウンドタスクのをデバッグする
UWP アプリで一時停止、再開、およびバックグラウンドイベントをトリガーする方法 (デバッグ時)

次の方法で共有

バックグラウンド タスクの進行状況と完了を監視する

完了したバックグラウンド タスクを処理するイベント ハンドラーを作成する

手順 1

手順 2

バックグラウンド タスクの進行状況を処理するイベント ハンドラー関数を作成する

手順 1

手順 2

イベント ハンドラー関数を新規および既存のバックグラウンド タスクに登録する

手順 1

手順 2

関連トピック

フィードバック

その他のリソース

バックグラウンドタスクの進行状況と完了を監視する

完了したバックグラウンドタスクを処理するイベントハンドラーを作成する

バックグラウンドタスクの進行状況を処理するイベントハンドラー関数を作成する

イベントハンドラー関数を新規および既存のバックグラウンドタスクに登録する