Package.StageContentGroupsAsync Method

Definition

Overloads

StageContentGroupsAsync(IIterable<String>)

Put the packages in the specified content groups into the staging queue.

StageContentGroupsAsync(IIterable<String>, Boolean)

Put the packages in the specified content groups into the staging queue; optionally placing the content groups at the head of the queue.

StageContentGroupsAsync(IIterable<String>)

Put the packages in the specified content groups into the staging queue.

public:
 virtual IAsyncOperation<IVector<PackageContentGroup ^> ^> ^ StageContentGroupsAsync(IIterable<Platform::String ^> ^ names) = StageContentGroupsAsync;
/// [Windows.Foundation.Metadata.Overload("StageContentGroupsAsync")]
/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperation<IVector<PackageContentGroup>> StageContentGroupsAsync(IIterable<winrt::hstring> const& names);
[Windows.Foundation.Metadata.Overload("StageContentGroupsAsync")]
[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperation<IList<PackageContentGroup>> StageContentGroupsAsync(IEnumerable<string> names);
function stageContentGroupsAsync(names)
Public Function StageContentGroupsAsync (names As IEnumerable(Of String)) As IAsyncOperation(Of IList(Of PackageContentGroup))

Parameters

names

IIterable<String>

IEnumerable<String>

IIterable<Platform::String>

IIterable<winrt::hstring>

The names of the content groups to stage.

Returns

A list of PackageContentGroup objects for each content group specified by the names parameter.

Attributes

Windows requirements

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

Remarks

This function completes when all requested groups are staged. The returned list may contain a null element if the named group in that position does not exist. Use PackageCatalog.PackageContentGroupStaging to observe staging progress.

Be sure to check PackageContentGroup.State to verify that the group was successfully staged. Referencing files in a group that is not fully staged may result in unexpected application behavior. Content groups return to the PackageContentGroupState.NotStaged state if the staging operation cannot be completed.

Applies to

StageContentGroupsAsync(IIterable<String>, Boolean)

Put the packages in the specified content groups into the staging queue; optionally placing the content groups at the head of the queue.

public:
 virtual IAsyncOperation<IVector<PackageContentGroup ^> ^> ^ StageContentGroupsAsync(IIterable<Platform::String ^> ^ names, bool moveToHeadOfQueue) = StageContentGroupsAsync;
/// [Windows.Foundation.Metadata.Overload("StageContentGroupsWithPriorityAsync")]
/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperation<IVector<PackageContentGroup>> StageContentGroupsAsync(IIterable<winrt::hstring> const& names, bool const& moveToHeadOfQueue);
[Windows.Foundation.Metadata.Overload("StageContentGroupsWithPriorityAsync")]
[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperation<IList<PackageContentGroup>> StageContentGroupsAsync(IEnumerable<string> names, bool moveToHeadOfQueue);
function stageContentGroupsAsync(names, moveToHeadOfQueue)
Public Function StageContentGroupsAsync (names As IEnumerable(Of String), moveToHeadOfQueue As Boolean) As IAsyncOperation(Of IList(Of PackageContentGroup))

Parameters

names

IIterable<String>

IEnumerable<String>

IIterable<Platform::String>

IIterable<winrt::hstring>

The names of the content groups to stage.

moveToHeadOfQueue
Boolean

bool

True to move the content group to the head of the staging queue; false otherwise.

Returns

A list of PackageContentGroup objects for each content group specified by the names parameter.

Attributes

Windows requirements

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

Remarks

This function completes when all requested groups are staged. The returned list may contain a null element if the named group in that position does not exist. Use PackageCatalog.PackageContentGroupStaging to observe staging progress.

Be sure to check PackageContentGroup.State to verify that the group was successfully staged. Referencing files in a group that is not fully staged may result in unexpected application behavior. Content groups return to the PackageContentGroupState.NotStaged state if the staging operation cannot be completed.

Applies to