PackageManager.RegisterPackageByFamilyNameAsync Method

Definition

Registers a Package (the main package) by its family name and its dependency packages for the current user.

public:
 virtual IAsyncOperationWithProgress<DeploymentResult ^, DeploymentProgress> ^ RegisterPackageByFamilyNameAsync(Platform::String ^ mainPackageFamilyName, IIterable<Platform::String ^> ^ dependencyPackageFamilyNames, DeploymentOptions deploymentOptions, PackageVolume ^ appDataVolume, IIterable<Platform::String ^> ^ optionalPackageFamilyNames) = RegisterPackageByFamilyNameAsync;
/// [Windows.Foundation.Metadata.Overload("RegisterPackageByFamilyNameAndOptionalPackagesAsync")]
/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperationWithProgress<DeploymentResult, DeploymentProgress> RegisterPackageByFamilyNameAsync(winrt::hstring const& mainPackageFamilyName, IIterable<winrt::hstring> const& dependencyPackageFamilyNames, DeploymentOptions const& deploymentOptions, PackageVolume const& appDataVolume, IIterable<winrt::hstring> const& optionalPackageFamilyNames);
[Windows.Foundation.Metadata.Overload("RegisterPackageByFamilyNameAndOptionalPackagesAsync")]
[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperationWithProgress<DeploymentResult,DeploymentProgress> RegisterPackageByFamilyNameAsync(string mainPackageFamilyName, IEnumerable<string> dependencyPackageFamilyNames, DeploymentOptions deploymentOptions, PackageVolume appDataVolume, IEnumerable<string> optionalPackageFamilyNames);
function registerPackageByFamilyNameAsync(mainPackageFamilyName, dependencyPackageFamilyNames, deploymentOptions, appDataVolume, optionalPackageFamilyNames)
Public Function RegisterPackageByFamilyNameAsync (mainPackageFamilyName As String, dependencyPackageFamilyNames As IEnumerable(Of String), deploymentOptions As DeploymentOptions, appDataVolume As PackageVolume, optionalPackageFamilyNames As IEnumerable(Of String)) As IAsyncOperationWithProgress(Of DeploymentResult, DeploymentProgress)

Parameters

mainPackageFamilyName
String

Platform::String

winrt::hstring

A string that specifies the family name of the main package to be registered.

dependencyPackageFamilyNames

IIterable<String>

IEnumerable<String>

IIterable<Platform::String>

IIterable<winrt::hstring>

Strings that specify the family names of the dependency packages to be registered.

deploymentOptions
DeploymentOptions

A DeploymentOptions-typed value that specifies the package deployment option.

appDataVolume
PackageVolume

The package volume to store that app data on.

optionalPackageFamilyNames

IIterable<String>

IEnumerable<String>

IIterable<Platform::String>

IIterable<winrt::hstring>

Strings that specify the optional package family names from the main bundle to be registered.

Returns

A report of the deployment progress. The object implements the IAsyncOperationWithProgress pattern.

Attributes

Windows requirements

Device family
Windows 10 Creators Update (introduced in 10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v4.0)

Applies to

See also