PackageManager.StagePackageAsync 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.
Overloads
| StagePackageAsync(Uri, IIterable<Uri>) |
Stages a Package to the system without registering it. |
| StagePackageAsync(Uri, IIterable<Uri>, DeploymentOptions) |
Stages a Package to the system without registering it. |
| StagePackageAsync(Uri, IIterable<Uri>, DeploymentOptions, PackageVolume) |
Stages a Package to the system without registering it. |
| StagePackageAsync(Uri, IIterable<Uri>, DeploymentOptions, PackageVolume, IIterable<String>, IIterable<Uri>) |
Stages a Package to the system without registering it. |
| StagePackageAsync(Uri, IIterable<Uri>, DeploymentOptions, PackageVolume, IIterable<String>, IIterable<Uri>, IIterable<Uri>) |
Stages a Package to the system without registering it. |
StagePackageAsync(Uri, IIterable<Uri>)
public:
virtual IAsyncOperationWithProgress<DeploymentResult ^, DeploymentProgress> ^ StagePackageAsync(Uri ^ packageUri, IIterable<Uri ^> ^ dependencyPackageUris) = StagePackageAsync;IAsyncOperationWithProgress<DeploymentResult, DeploymentProgress> StagePackageAsync(Uri const& packageUri, IIterable<Uri> const& dependencyPackageUris);public IAsyncOperationWithProgress<DeploymentResult,DeploymentProgress> StagePackageAsync(System.Uri packageUri, IEnumerable<System.Uri> dependencyPackageUris);function stagePackageAsync(packageUri, dependencyPackageUris)Public Function StagePackageAsync (packageUri As Uri, dependencyPackageUris As IEnumerable(Of Uri)) As IAsyncOperationWithProgress(Of DeploymentResult, DeploymentProgress)Parameters
- dependencyPackageUris
The source URIs of the dependency packages. If there are no dependency packages or dependency packages are already staged, this parameter can be null.
Returns
The status of the deployment request. The DeploymentResult contains the final returned value of the deployment operation, once it is completed. The DeploymentProgress can be used to obtain the percentage of completion over the entire course of the deployment operation.
Remarks
The stage operation will extract the package payload to disk under %ProgramFiles%\WindowsApps.
See also
Applies to
StagePackageAsync(Uri, IIterable<Uri>, DeploymentOptions)
public:
virtual IAsyncOperationWithProgress<DeploymentResult ^, DeploymentProgress> ^ StagePackageAsync(Uri ^ packageUri, IIterable<Uri ^> ^ dependencyPackageUris, DeploymentOptions deploymentOptions) = StagePackageAsync;/// [Windows.Foundation.Metadata.Overload("StagePackageWithOptionsAsync")]
/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperationWithProgress<DeploymentResult, DeploymentProgress> StagePackageAsync(Uri const& packageUri, IIterable<Uri> const& dependencyPackageUris, DeploymentOptions const& deploymentOptions);[Windows.Foundation.Metadata.Overload("StagePackageWithOptionsAsync")]
[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperationWithProgress<DeploymentResult,DeploymentProgress> StagePackageAsync(System.Uri packageUri, IEnumerable<System.Uri> dependencyPackageUris, DeploymentOptions deploymentOptions);function stagePackageAsync(packageUri, dependencyPackageUris, deploymentOptions)Public Function StagePackageAsync (packageUri As Uri, dependencyPackageUris As IEnumerable(Of Uri), deploymentOptions As DeploymentOptions) As IAsyncOperationWithProgress(Of DeploymentResult, DeploymentProgress)Parameters
- dependencyPackageUris
The source URIs of the dependency packages. If there are no dependency packages or dependency packages are already staged, this parameter can be null.
- deploymentOptions
- DeploymentOptions
A combination of DeploymentOptions-typed values that are combined by using a bitwise OR operation. The resulting value specifies the package deployment options.
Returns
The status of the deployment request. The DeploymentResult contains the final returned value of the deployment operation, once it is completed. The DeploymentProgress can be used to obtain the percentage of completion over the entire course of the deployment operation.
- Attributes
See also
Applies to
StagePackageAsync(Uri, IIterable<Uri>, DeploymentOptions, PackageVolume)
public:
virtual IAsyncOperationWithProgress<DeploymentResult ^, DeploymentProgress> ^ StagePackageAsync(Uri ^ packageUri, IIterable<Uri ^> ^ dependencyPackageUris, DeploymentOptions deploymentOptions, PackageVolume ^ targetVolume) = StagePackageAsync;/// [Windows.Foundation.Metadata.Overload("StagePackageToVolumeAsync")]
/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperationWithProgress<DeploymentResult, DeploymentProgress> StagePackageAsync(Uri const& packageUri, IIterable<Uri> const& dependencyPackageUris, DeploymentOptions const& deploymentOptions, PackageVolume const& targetVolume);[Windows.Foundation.Metadata.Overload("StagePackageToVolumeAsync")]
[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperationWithProgress<DeploymentResult,DeploymentProgress> StagePackageAsync(System.Uri packageUri, IEnumerable<System.Uri> dependencyPackageUris, DeploymentOptions deploymentOptions, PackageVolume targetVolume);function stagePackageAsync(packageUri, dependencyPackageUris, deploymentOptions, targetVolume)Public Function StagePackageAsync (packageUri As Uri, dependencyPackageUris As IEnumerable(Of Uri), deploymentOptions As DeploymentOptions, targetVolume As PackageVolume) As IAsyncOperationWithProgress(Of DeploymentResult, DeploymentProgress)Parameters
- dependencyPackageUris
The source URIs of the dependency packages. If there are no dependency packages or dependency packages are already staged, this parameter can be null.
- deploymentOptions
- DeploymentOptions
A bitwise combination of enumeration values from the DeploymentOptions enumeration. The resulting value specifies the package deployment options.
- targetVolume
- PackageVolume
The target volume on which to stage the package.
Returns
An object that the caller can observe to track progress and completion for the call. The object implements the IAsyncOperationWithProgress pattern.
- Attributes
See also
- StagePackageAsync(Uri, IIterable<Uri>)
- StagePackageAsync(Uri, IIterable<Uri>, DeploymentOptions)
- Package
Applies to
StagePackageAsync(Uri, IIterable<Uri>, DeploymentOptions, PackageVolume, IIterable<String>, IIterable<Uri>)
public:
virtual IAsyncOperationWithProgress<DeploymentResult ^, DeploymentProgress> ^ StagePackageAsync(Uri ^ packageUri, IIterable<Uri ^> ^ dependencyPackageUris, DeploymentOptions deploymentOptions, PackageVolume ^ targetVolume, IIterable<Platform::String ^> ^ optionalPackageFamilyNames, IIterable<Uri ^> ^ externalPackageUris) = StagePackageAsync;/// [Windows.Foundation.Metadata.DefaultOverload]
/// [Windows.Foundation.Metadata.Overload("StagePackageToVolumeAndOptionalPackagesAsync")]
/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperationWithProgress<DeploymentResult, DeploymentProgress> StagePackageAsync(Uri const& packageUri, IIterable<Uri> const& dependencyPackageUris, DeploymentOptions const& deploymentOptions, PackageVolume const& targetVolume, IIterable<winrt::hstring> const& optionalPackageFamilyNames, IIterable<Uri> const& externalPackageUris);[Windows.Foundation.Metadata.DefaultOverload]
[Windows.Foundation.Metadata.Overload("StagePackageToVolumeAndOptionalPackagesAsync")]
[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperationWithProgress<DeploymentResult,DeploymentProgress> StagePackageAsync(System.Uri packageUri, IEnumerable<System.Uri> dependencyPackageUris, DeploymentOptions deploymentOptions, PackageVolume targetVolume, IEnumerable<string> optionalPackageFamilyNames, IEnumerable<System.Uri> externalPackageUris);function stagePackageAsync(packageUri, dependencyPackageUris, deploymentOptions, targetVolume, optionalPackageFamilyNames, externalPackageUris)Public Function StagePackageAsync (packageUri As Uri, dependencyPackageUris As IEnumerable(Of Uri), deploymentOptions As DeploymentOptions, targetVolume As PackageVolume, optionalPackageFamilyNames As IEnumerable(Of String), externalPackageUris As IEnumerable(Of Uri)) As IAsyncOperationWithProgress(Of DeploymentResult, DeploymentProgress)Parameters
- dependencyPackageUris
The source URIs of the dependency packages. If there are no dependency packages or dependency packages are already staged, this parameter can be null.
- deploymentOptions
- DeploymentOptions
A bitwise combination of enumeration values from the DeploymentOptions enumeration. The resulting value specifies the package deployment options.
- targetVolume
- PackageVolume
The target volume on which to stage the package.
Strings that specify the optional package family names from the main bundle to be staged.
- externalPackageUris
The source URIs of other packages in the main bundle to be staged.
Returns
An object that the caller can observe to track progress and completion for the call. 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)
|
See also
Applies to
StagePackageAsync(Uri, IIterable<Uri>, DeploymentOptions, PackageVolume, IIterable<String>, IIterable<Uri>, IIterable<Uri>)
public:
virtual IAsyncOperationWithProgress<DeploymentResult ^, DeploymentProgress> ^ StagePackageAsync(Uri ^ packageUri, IIterable<Uri ^> ^ dependencyPackageUris, DeploymentOptions options, PackageVolume ^ targetVolume, IIterable<Platform::String ^> ^ optionalPackageFamilyNames, IIterable<Uri ^> ^ packageUrisToInstall, IIterable<Uri ^> ^ relatedPackageUris) = StagePackageAsync;/// [Windows.Foundation.Metadata.Overload("StagePackageToVolumeAndRelatedSetAsync")]
/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperationWithProgress<DeploymentResult, DeploymentProgress> StagePackageAsync(Uri const& packageUri, IIterable<Uri> const& dependencyPackageUris, DeploymentOptions const& options, PackageVolume const& targetVolume, IIterable<winrt::hstring> const& optionalPackageFamilyNames, IIterable<Uri> const& packageUrisToInstall, IIterable<Uri> const& relatedPackageUris);[Windows.Foundation.Metadata.Overload("StagePackageToVolumeAndRelatedSetAsync")]
[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperationWithProgress<DeploymentResult,DeploymentProgress> StagePackageAsync(System.Uri packageUri, IEnumerable<System.Uri> dependencyPackageUris, DeploymentOptions options, PackageVolume targetVolume, IEnumerable<string> optionalPackageFamilyNames, IEnumerable<System.Uri> packageUrisToInstall, IEnumerable<System.Uri> relatedPackageUris);function stagePackageAsync(packageUri, dependencyPackageUris, options, targetVolume, optionalPackageFamilyNames, packageUrisToInstall, relatedPackageUris)Public Function StagePackageAsync (packageUri As Uri, dependencyPackageUris As IEnumerable(Of Uri), options As DeploymentOptions, targetVolume As PackageVolume, optionalPackageFamilyNames As IEnumerable(Of String), packageUrisToInstall As IEnumerable(Of Uri), relatedPackageUris As IEnumerable(Of Uri)) As IAsyncOperationWithProgress(Of DeploymentResult, DeploymentProgress)Parameters
- dependencyPackageUris
The URIs of framework dependencies to add. If there are no dependency packages or if the dependency packages are already registered, this parameter can be null.
- options
- DeploymentOptions
The deployment options for the package.
- targetVolume
- PackageVolume
The volume to which the package is added.
The package family names from the main bundle to be staged.
- packageUrisToInstall
- relatedPackageUris
The URIs of additional packages in the main bundle that should be staged.
Returns
The status of the deployment request. The DeploymentResult contains the final returned value of the deployment operation, once it is completed. The DeploymentProgress can be used to obtain the percentage of completion over the entire course of the deployment operation.
- Attributes
Windows requirements
| Device family |
Windows 10 Fall Creators Update (introduced in 10.0.16299.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced in v5.0)
|
See also
Applies to
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for