PackageCatalog.AddResourcePackageAsync(String, String, AddResourcePackageOptions) Method

Definition

Adds a resource package to an existing app package.

public:
 virtual IAsyncOperationWithProgress<PackageCatalogAddResourcePackageResult ^, PackageInstallProgress> ^ AddResourcePackageAsync(Platform::String ^ resourcePackageFamilyName, Platform::String ^ resourceID, AddResourcePackageOptions options) = AddResourcePackageAsync;
/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperationWithProgress<PackageCatalogAddResourcePackageResult, PackageInstallProgress> AddResourcePackageAsync(winrt::hstring const& resourcePackageFamilyName, winrt::hstring const& resourceID, AddResourcePackageOptions const& options);
[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperationWithProgress<PackageCatalogAddResourcePackageResult,PackageInstallProgress> AddResourcePackageAsync(string resourcePackageFamilyName, string resourceID, AddResourcePackageOptions options);
function addResourcePackageAsync(resourcePackageFamilyName, resourceID, options)
Public Function AddResourcePackageAsync (resourcePackageFamilyName As String, resourceID As String, options As AddResourcePackageOptions) As IAsyncOperationWithProgress(Of PackageCatalogAddResourcePackageResult, PackageInstallProgress)

Parameters

resourcePackageFamilyName
String

Package family name that uniquely identifies the app's package.

resourceID
String

The resource ID of the package.

options
AddResourcePackageOptions

Options to specify the behavior when adding a resource package to an app.

Returns

IAsyncOperationWithProgress<PackageCatalogAddResourcePackageResult,PackageInstallProgress>

The progress report of adding a resource package.

Attributes

Windows requirements

Device family
Windows 10, version 1803 (introduced in 10.0.17134.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v6.0)

Examples

async void btnInstallFrenchProofingTools_Click(object sender, EventArgs e) 
{ 
    var packageCatalog = PackageCatalog.OpenForCurrentPackage(); 
    string familyName = "Microsoft.Word_8wekyb3d8bbwe"; 
    // The resourceId specified in the AppxManifest.xml should be unique within a PackageFamily
    string resourceId = "FR_ProofingTools"; 

    // Install the resource package and start reporting progress on the current 
    // progressBar in the UI
    var installedPackage = await packageCatalog.AddResourcePackageAsync(familyName, resourceId, AddResourcePackageOptions.RestartApplication) 
    .AsTask<PackageCatalogAddResourcePackageResult, PackageInstallProgress>(new Progress<PackageInstallProgress> 
    (progress => { progressBar.CurrentValue = progress.PercentComplete; })); 
} 

Applies to