PackageTransferStatus Enumeration

Indicates the status of a downloadable content transfer.

Syntax

public enum class PackageTransferStatus  

Members

Member Value Description
Error The transfer stopped due to an error.
None No installer activity is scheduled. Installation has already completed successfully.
Paused The install has been paused by the user.
Running The install is actively working.
Waiting The system is busy, and the installer is waiting to run. The current title is not actively installing.

Remarks

If your code is monitoring an installation and determines that it has taken too long for a chunk to install, check the PackageTransferManager::TransferStatus value to see if the installation has been stopped, been paused, or encountered an error. If the installer is no longer in the Running or Paused state, then you should take action to mitigate this for the user.

You should examine the TransferStatus property once per frame at most. Ideally, you should check it only in response to a chunk taking longer than your title expects or to the user trying to initiate an action they cannot perform until the chunk is present.

Network installations and download times can vary considerably, so applying a simple timeout may lead to false failures. If you have a watchdog for chunk installation and TransferStatus returns Running, you should continue waiting for the chunk and handle the delay in your title code. Do not assume that it has failed.

See the System Behavior When Title Installation Fails (Developer Education Materials > All NDA Whitepapers) white paper on the White Papers XGD page for additional information.

Requirements

Namespace: Windows.Xbox.Management.Deployment

Metadata: windows.winmd

See also

Reference

Windows.Xbox.Management.Deployment Namespace