監視背景工作進度和完成

重要 API

• BackgroundTaskRegistration
• BackgroundTaskProgressEventHandler
• BackgroundTaskCompletedEventHandler

了解您的應用程式如何識別程序外執行的背景工作報告的進度和完成情況。+ (對於程序內背景工作，您可以設定共享變數來表示進度和完成。)

背景工作進度和完成可由應用程式程式代碼監視。 若要這樣做，應用程式會訂閱已向系統註冊的背景工作的事件。

• 本主題假設您有註冊背景工作的應用程式。 若要開始快速建置背景工作，請參閱建立並註冊程序外背景工作或建立並註冊程序內背景工作。 有關條件和觸發程序的更深入資訊，請參閱透過背景工作支援您的應用程式。

建立事件處理程序來處理已完成的背景工作

步驟 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 應用程式中觸發暫停、繼續和背景事件 (在偵錯時)