XStoreDownloadAndInstallPackageUpdatesAsync

Article
11/09/2023

Downloads and installs updates for the specified store packages.

Syntax

HRESULT XStoreDownloadAndInstallPackageUpdatesAsync(  
         const XStoreContextHandle storeContextHandle,  
         const char** packageIdentifiers,  
         size_t packageIdentifiersCount,  
         XAsyncBlock* async  
)

Parameters

storeContextHandle _In_
Type: XStoreContextHandle

The store context handle for the user returned by XStoreCreateContext.

packageIdentifiers _In_z_count_(packageIdentifiersCount)
Type: char**

List of package identifier strings. A package identifier uniquely identifies a package from the Microsoft store. For more information about package identifiers, see Manage and license downloadable content (DLC).

packageIdentifiersCount _In_
Type: size_t

The number of Identifiers in packageIdentifiers.

async _Inout_
Type: XAsyncBlock*

An XAsyncBlock defining the asynchronous work being done. The XAsyncBlock can be used to poll for the call's status and retrieve call results. See XAsyncBlock for more information.

Return value

Type: HRESULT

HRESULT success or error code.

Remarks

This function downloads and installs updates to for a specified store package. If you would like to download the updates without installing them call XStoreDownloadPackageUpdatesAsync. Downloading without installing is useful when the game is running so that you do not disturb gameplay. To retrieve the results of the download and install update, call XStoreDownloadAndInstallPackageUpdatesResult after calling this function. See XStoreQueryGameAndDlcPackageUpdatesAsync for a usage example.

When this API is called from a running game, then the downloads will be considered high priority and they will go at the beginning of the queue in the order in which they are specified in the storeIds parameter of this API.

Requirements

Header: XStore.h (included in XGameRuntime.h)

Library: xgameruntime.lib

Supported platforms: Windows, Xbox One family consoles and Xbox Series consoles

Share via