PackageManager.AddPackageByAppInstallerFileAsync Method
Definition
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.
public:
virtual IAsyncOperationWithProgress<DeploymentResult ^, DeploymentProgress> ^ AddPackageByAppInstallerFileAsync(Uri ^ appInstallerFileUri, AddPackageByAppInstallerOptions options, PackageVolume ^ targetVolume) = AddPackageByAppInstallerFileAsync;
/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperationWithProgress<DeploymentResult, DeploymentProgress> AddPackageByAppInstallerFileAsync(Uri const& appInstallerFileUri, AddPackageByAppInstallerOptions const& options, PackageVolume const& targetVolume);
[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperationWithProgress<DeploymentResult,DeploymentProgress> AddPackageByAppInstallerFileAsync(System.Uri appInstallerFileUri, AddPackageByAppInstallerOptions options, PackageVolume targetVolume);
function addPackageByAppInstallerFileAsync(appInstallerFileUri, options, targetVolume)
Public Function AddPackageByAppInstallerFileAsync (appInstallerFileUri As Uri, options As AddPackageByAppInstallerOptions, targetVolume As PackageVolume) As IAsyncOperationWithProgress(Of DeploymentResult, DeploymentProgress)
Parameters
- options
- AddPackageByAppInstallerOptions
The options as specified in AddPackageByAppInstallerOptions.
- targetVolume
- PackageVolume
The volume that the package is installed to.
Returns
An IAsyncOperationWithProgress with a DeploymentResult that indicates whether the deployment was successful, and DeploymentProgress that provides progress updates during the installation.
- Attributes
Windows requirements
| Requirements | Description |
|---|---|
| Device family |
Windows 10 Fall Creators Update (introduced in 10.0.16299.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced in v5.0)
|
| App capabilities |
packageManagement
|
Examples
The following example uses AddPackageByAppInstallerFileAsync to install packages defined in an .appinstaller file. Note that the returned IAsyncOperationWithProgress is assigned to a variable before monitoring its completion. Failing to hold a reference to the operation can cause it to be garbage-collected and never complete.
using System;
using System.Threading;
using Windows.Foundation;
using Windows.Management.Deployment;
public static int Main(string[] args)
{
string inputFileUri = args[0];
int returnValue = 0;
Uri appInstallerFileUri = new Uri(inputFileUri);
PackageManager packageManager = new PackageManager();
PackageVolume packageVolume = packageManager.GetDefaultPackageVolume();
// Important: assign the operation to a variable to prevent it from
// being garbage-collected before completion.
IAsyncOperationWithProgress<DeploymentResult, DeploymentProgress> deploymentOperation =
packageManager.AddPackageByAppInstallerFileAsync(
appInstallerFileUri,
AddPackageByAppInstallerOptions.ForceTargetAppShutdown,
packageVolume);
// This event is signaled when the operation completes
ManualResetEvent opCompletedEvent = new ManualResetEvent(false);
// Define the delegate using a statement lambda
deploymentOperation.Completed = (operation, status) => { opCompletedEvent.Set(); };
// Wait until the operation completes
opCompletedEvent.WaitOne();
// Check the status of the operation
if (deploymentOperation.Status == AsyncStatus.Error)
{
DeploymentResult deploymentResult = deploymentOperation.GetResults();
Console.WriteLine("Error code: {0}", deploymentOperation.ErrorCode);
Console.WriteLine("Error text: {0}", deploymentResult.ErrorText);
returnValue = 1;
}
else if (deploymentOperation.Status == AsyncStatus.Canceled)
{
Console.WriteLine("Installation canceled");
}
else if (deploymentOperation.Status == AsyncStatus.Completed)
{
Console.WriteLine("Installation succeeded");
}
else
{
returnValue = 1;
Console.WriteLine("Installation status unknown");
}
return returnValue;
}
Remarks
This method is not supported in JavaScript. However, you can create a Windows Runtime component that calls this method and then call this component from a JavaScript UWP app. For more information, see App Installer file API issues.