Windows.Management.Update Namespace

Classes

Enums

Examples

Scan for and enumerate applicable updates

This C# example creates a WindowsUpdateManager, starts a scan, and enumerates the applicable updates when the scan completes.

using System;
using Windows.Management.Update;

var updateManager = new WindowsUpdateManager("MyClientId");

updateManager.ScanCompleted += (manager, args) =>
{
    foreach (WindowsUpdate update in manager.GetApplicableUpdates())
    {
        Console.WriteLine($"Applicable update: {update.Title}");
    }
};

// Scan as if the user selected "Check for updates".
updateManager.StartScan(userInitiated: true);

Author a software-update provider

The Windows Software Update provider platform lets you plug a custom update source into the Windows Update Orchestrator. A provider is invoked in SYSTEM context once per operation: during a scan it builds WindowsSoftwareUpdate objects and submits them; during an action it reports progress and a final result through a WindowsSoftwareUpdateProviderStatus.

The following snippets show that core flow in C#, C++/WinRT, and PowerShell. Complete, buildable provider samples — including the provider.json manifest, code-signing, and registration steps — are published in the microsoft/windows-uop repository.

C#

using System.Collections.Generic;
using Windows.Management.Update;

// Scan: report the updates this provider offers.
void PerformScan(string providerId, IEnumerable<WindowsSoftwareUpdate> updates)
{
    var status = new WindowsSoftwareUpdateProviderStatus(providerId);
    WindowsSoftwareUpdateResult result = status.SetScanResult(true, 0, 0, updates);
}

// Action: report progress, then the final result.
void PerformAction(string providerId)
{
    var status = new WindowsSoftwareUpdateProviderStatus(providerId);

    for (ulong i = 0; i <= 100; i += 10)
    {
        status.SetActionProgress(i, 100);
    }

    var actionResult = new WindowsSoftwareUpdateProviderActionResult(
        WindowsSoftwareUpdateActionResult.Succeeded,
        WindowsSoftwareUpdateRestartReason.None,
        resultCode: 0,
        extendedError: 0);
    status.SetActionResult(actionResult);
}

C++/WinRT

#include <winrt/Windows.Management.Update.h>
#include <winrt/Windows.Foundation.Collections.h>

using namespace winrt::Windows::Management::Update;
using namespace winrt::Windows::Foundation::Collections;

// Scan: report the updates this provider offers.
void PerformScan(winrt::hstring const& providerId, IVector<WindowsSoftwareUpdate> const& updates)
{
    WindowsSoftwareUpdateProviderStatus status{ providerId };
    auto result = status.SetScanResult(true, S_OK, 0, updates);
}

// Action: report progress, then the final result.
void PerformAction(winrt::hstring const& providerId)
{
    WindowsSoftwareUpdateProviderStatus status{ providerId };

    for (uint64_t i = 0; i <= 100; i += 10)
    {
        status.SetActionProgress(i, 100);
    }

    WindowsSoftwareUpdateProviderActionResult actionResult{
        WindowsSoftwareUpdateActionResult::Succeeded,
        WindowsSoftwareUpdateRestartReason::None,
        0,   // resultCode
        0 }; // extendedError
    status.SetActionResult(actionResult);
}

PowerShell

# Scan: report the updates this provider offers.
$providerStatus = [Windows.Management.Update.WindowsSoftwareUpdateProviderStatus]::new($ProviderId)
$statusResult   = $providerStatus.SetScanResult($true, 0, 0, $UpdateCollection)

# Action: report progress, then the final result.
$providerStatus = [Windows.Management.Update.WindowsSoftwareUpdateProviderStatus]::new($ProviderId)
for ($i = 0; $i -le 100; $i += 10) {
    [void]$providerStatus.SetActionProgress($i, 100)
}

$actionResult = [Windows.Management.Update.WindowsSoftwareUpdateProviderActionResult]::new(
    [Windows.Management.Update.WindowsSoftwareUpdateActionResult]::Succeeded,
    [Windows.Management.Update.WindowsSoftwareUpdateRestartReason]::None,
    0,   # resultCode
    0)   # extendedError
[void]$providerStatus.SetActionResult($actionResult)

Determine Insider Preview build status (IoT)

This C# example demonstrates how a user can determine whether their device is receiving preview builds, or whether there are problems preventing the device from getting preview builds.

public string GetErrorMessage() 
{ 
    PreviewBuildsManager manager = PreviewBuildsManager.GetDefault(); 
    if (manager != null) 
    { 
        PreviewBuildsState state = manager.GetCurrentState(); 
        if (state.Properties.ContainsKey("ErrorMessage")) 
        { 
            return state.Properties["ErrorMessage"].ToString(); 
        } 
    } 
    return String.Empty; 
} 

Remarks

• Use WindowsUpdateManager, WindowsUpdate, and WindowsUpdateAdministrator for general update management on all supported platforms.
• Use WindowsSoftwareUpdateProvider, WindowsSoftwareUpdateProviderStatus, WindowsSoftwareUpdate, and the software-update members of WindowsUpdateManager to author and host update providers for your app (the Windows Update Orchestration Platform). For provider authoring, onboarding, signing, and registration guidance — along with complete C#, C++, and PowerShell samples — see the microsoft/windows-uop repository.
• PreviewBuildsManager and PreviewBuildsState are IoT specific and do not manage general updates on desktop or Server. It's expected that the OEM of the device will create a settings page within the Windows Device Portal for device configuration properties. Information from PreviewBuildsState will be read by the device, then displayed to the user, and then used to register the user's account to the device. After registration, all settings management will be done online through the Windows Insider Program instead of on the device itself.
• Platform availability and API contracts are documented in individual class reference pages.

See also

• WindowsUpdateManager
• WindowsUpdate
• WindowsUpdateAdministrator
• WindowsSoftwareUpdateProvider
• WindowsSoftwareUpdate
• WindowsSoftwareUpdateProviderStatus
• PreviewBuildsManager
• microsoft/windows-uop samples