Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Reference material for XPackage APIs.
Functions
| Function | Description |
|---|---|
| XPackageChangeChunkInstallOrder | Sets the selected chunks to install first. |
| XPackageChunkAvailabilityCallback | A user-defined callback used by XPackageEnumerateChunkAvailability. |
| XPackageCloseInstallationMonitorHandle | Closes a specified installation monitor. |
| XPackageCloseMountHandle | Closes the specified mount handle. |
| XPackageCreateInstallationMonitor | Creates a monitor of the state of an installation. |
| XPackageEnumerateChunkAvailability | Examines the installation package and enumerates the availability of all chunks that match the specified selectors. |
| XPackageEnumerateFeatures | Enumerates features defined in the package's layout file. |
| XPackageEnumeratePackages | Finds installed or installing packages related to the calling process. |
| XPackageEnumerationCallback | A callback used by XPackageEnumeratePackages. |
| XPackageEstimateDownloadSize | Computes the download size of the chunks that match the specified installation selectors. |
| XPackageFeatureEnumerationCallback | The callback used by XPackageEnumerateFeatures to enumerate each feature. |
| XPackageFindChunkAvailability | Returns the minimum availability for the collection of chunks that match the specified selectors. |
| XPackageGetCurrentProcessPackageIdentifier | Returns an installation identity string that identifies the installation for this process. |
| XPackageGetInstallationProgress | Returns the current progress of an installation. |
| XPackageGetMountPath | Gets the path to a mounted installation. |
| XPackageGetMountPathSize | Gets the size required for an array to hold a mount path returned by XPackageGetMountPath. |
| XPackageGetUserLocale | Gets the current user locale. |
| XPackageGetWriteStats | Gets the output write statistics (writeStats). |
| XPackageInstallationProgressCallback | A callback used by XPackageRegisterInstallationProgressChanged. |
| XPackageInstallChunks | Starts the installation of chunks. |
| XPackageInstallChunksAsync | Starts installation of chunks. |
| XPackageInstallChunksResult | Retrieves the result of a call to XPackageInstallChunksAsync. |
| XPackageInstalledCallback | A user-defined callback used by the XPackageRegisterPackageInstalled function. |
| XPackageIsPackagedProcess | Returns a Boolean that indicates whether the current process has an installation identity. |
| XPackageMount | This function is now deprecated. Use XPackageMountWithUiAsync instead. |
| XPackageMountWithUiAsync | Asynchronously mounts the installation of specified content, and returns a mount handle to it. |
| XPackageMountWithUiResult | Gets the results of a call to XPackageMountWithUIAsync. |
| XPackageRegisterInstallationProgressChanged | Registers a callback to be called when installation progress changes. |
| XPackageRegisterPackageInstalled | Registers a callback to be called when an installation is completed. |
| XPackageUninstallPackage | Uninstalls a given package. |
| XPackageUninstallChunks | Uninstalls chunks that match the specified selectors. |
| XPackageUninstallUWPInstance | Uninstalls a Universal Windows Platform (UWP) instance of a particular package for the current user if one is currently installed. |
| XPackageUnregisterInstallationProgressChanged | Unregisters a previously registered install progress changed callback. |
| XPackageUnregisterPackageInstalled | Unregisters a previously registered install complete callback. |
| XPackageUpdateInstallationMonitor | Refreshes the progress returned from XPackageGetInstallationProgress. |
Structures
| Structure | Description |
|---|---|
| XPackageChunkSelector | Defines the criteria for selecting a set of chunks. |
| XPackageDetails | Contains details about an installation. |
| XPackageFeature | Describes a feature. |
| XPackageInstallationProgress | Contains information about the progress of an installation. |
| XPackageWriteStats | Contains the output write statistics (writeStats). |
Enumerations
| Enumeration | Description |
|---|---|
| XPackageChunkAvailability | Indicates the availability of installation chunks. |
| XPackageChunkSelectorType | Indicates the selector type. |
| XPackageEnumerationScope | Indicates the scope of packages to be returned when installation packages are being enumerated. |
| XPackageKind | Indicates the type of the installation package. |
Error Codes
The following error codes may be returned by XPackage APIs. For a complete list, see Error codes.
| Code | Value | Description |
|---|---|---|
| E_GAMEPACKAGE_APP_NOT_PACKAGED | 0x89245200 | The game is not packaged in a container. |
| E_GAMEPACKAGE_NO_INSTALLED_LANGUAGES | 0x89245201 | The game uses Intelligent Delivery to selectively install languages, but none are installed. |
| E_GAMEPACKAGE_NO_STORE_ID | 0x89245202 | The StoreId attribute must be set in the application's game config. |
| E_GAMEPACKAGE_INVALID_SELECTOR | 0x89245203 | A chunk selector was provided that does not resolve to a chunk in the package. |
| E_GAMEPACKAGE_DOWNLOAD_REQUIRED | 0x89245204 | One or more required chunks must be downloaded to mount the package on this device. |
| E_GAMEPACKAGE_NO_TAG_CHANGE | 0x89245205 | Change installed chunks in this package using Features, not tags. |
| E_GAMEPACKAGE_DLC_NOT_SUPPORTED | 0x89245206 | Game does not support the DLC package. Ensure correct DLC compatibility in the game config. |
| E_GAMEPACKAGE_DUPLICATE_ID_VALUES | 0x89245207 | The package contains more than one executable mapping to the same 'ID' attribute. Check for duplicate 'ID' attributes in the 'Executable' elements. |
| E_GAMEPACKAGE_NO_PACKAGE_IDENTIFIER | 0x89245208 | Could not resolve an identifier for the package. The package might not be installed. |
Conceptual documentation
- XStore checking for updates
- XStore grant access to content
- XStore manage and license optional packages