PackageDeploymentManager.EnsurePackageSetReadyAsync Method

Reference

Definition

Namespace:: Microsoft.Windows.Management.Deployment

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

Asynchronously determines whether the target package set is present (installed, registered) and ready for use; and, if not, puts it in that state. That can involve downloading the target, registering it for the user, and remediating a package in an unhealthy state.

public:
 virtual IAsyncOperationWithProgress<PackageDeploymentResult ^, PackageDeploymentProgress> ^ EnsurePackageSetReadyAsync(PackageSet ^ packageSet, EnsureReadyOptions ^ options) = EnsurePackageSetReadyAsync;

IAsyncOperationWithProgress<PackageDeploymentResult, PackageDeploymentProgress> EnsurePackageSetReadyAsync(PackageSet const& packageSet, EnsureReadyOptions const& options);

public IAsyncOperationWithProgress<PackageDeploymentResult,PackageDeploymentProgress> EnsurePackageSetReadyAsync(PackageSet packageSet, EnsureReadyOptions options);

function ensurePackageSetReadyAsync(packageSet, options)

Public Function EnsurePackageSetReadyAsync (packageSet As PackageSet, options As EnsureReadyOptions) As IAsyncOperationWithProgress(Of PackageDeploymentResult, PackageDeploymentProgress)

Parameters

packageSet: PackageSet

The target package set to query about.

options: EnsureReadyOptions

Ensure-ready options for the operation.

Returns

IAsyncOperationWithProgress<PackageDeploymentResult,PackageDeploymentProgress>

An asynchronous operation object which, when it completes, contains a value representing the result of the operation.

Examples

A Fabrikam app installing Contoso's Example1 and Example2 packages, if necessary, and with explicit user confirmation before the installation.

void Install()
{
    var packageSet = new PackageSet() {
        Items = { new PackageSetItem() { PackageFamilyName = "contoso.example1_1234567890abc",
                                         MinVersion = ToVersion(1, 2, 3, 4),
                                         PackageUri = new Uri("c:\\contoso\\example1-1.2.3.4.msix") },
                { new PackageSetItem() { PackageFamilyName = "contoso.example2_1234567890abc",
                                         MinVersion = ToVersion(2, 4, 6, 8),
                                         PackageUri = new Uri("https://contoso.com/example2-2.4.6.8.msix") } };

    var packageDeploymentManager = PackageDeploymentManager.GetDefault();
    if (!packageDeploymentManager.IsPackageSetReady(packageSet))
    {
        bool ok = PromptUserForConfirmation();
        if (!ok)
        {
            return;
        }
    }

    var options = new EnsureReadyOptions();
    var deploymentResult = await packageDeploymentManager.EnsurePackageSetReadyAsync(packageSet, options);
    if (deplymentResult.Status == PackageDeploymentStatus.CompletedSuccess)
    {
        Console.WriteLine("OK");
    }
    else
    {
        Console.WriteLine("Error:{} ExtendedError:{} {}",
            deploymentResult.Error.HResult, deploymentResult.ExtendedError.HResult, deploymentResult.ErrorText);
    }
}

PackageVersion ToVersion(uint major, uint minor, uint build, uint revision) =>
    new PackageVersion {
        Major = checked((ushort)major),
        Minor = checked((ushort)minor),
        Build = checked((ushort)build),
        Revision = checked((ushort)revision)
    };

Remarks

See Remarks for EnsurePackageReadyAsync.

Applies to

Share via