PackageCatalog.RemoveOptionalPackagesAsync(IIterable<String>) Method

public:
 virtual IAsyncOperation<PackageCatalogRemoveOptionalPackagesResult ^> ^ RemoveOptionalPackagesAsync(IIterable<Platform::String ^> ^ optionalPackageFamilyNames) = RemoveOptionalPackagesAsync;

/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperation<PackageCatalogRemoveOptionalPackagesResult> RemoveOptionalPackagesAsync(IIterable<winrt::hstring> const& optionalPackageFamilyNames);

[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperation<PackageCatalogRemoveOptionalPackagesResult> RemoveOptionalPackagesAsync(IEnumerable<string> optionalPackageFamilyNames);

function removeOptionalPackagesAsync(optionalPackageFamilyNames)

Public Function RemoveOptionalPackagesAsync (optionalPackageFamilyNames As IEnumerable(Of String)) As IAsyncOperation(Of PackageCatalogRemoveOptionalPackagesResult)

Parameters

Returns

The result of removing the optional package in the form of: PackageCatalogRemoveOptionalPackagesResult.

Attributes

RemoteAsyncAttribute

Windows requirements

Examples

This sample demonstrates removing all of the optional packages from a main app package.

public async void RemoveOptionalPackages() 
{ 
    // Create a list of the optional package family names
    List<string> optionalPackageList = new List<string>(); 
    foreach (var package in Windows.ApplicationModel.Package.Current.Dependencies) 
    { 
        if (package.IsOptional) 
        { 
            optionalPackageList.Add(package.Id.FamilyName); 
        } 
    } 

    // Remove the optional packages from the list    
    PackageCatalog catalog = Windows.ApplicationModel.PackageCatalog.OpenForCurrentPackage(); 
    var removalResult = await catalog.RemoveOptionalPackagesAsync(optionalPackageList); 
    if (removalResult.ExtendedError != null) 
    { 
        throw removalResult.ExtendedError; 
    } 
}

Remarks

A package family name can be found in the FamilyName property of the PackageId.