XStoreDownloadPackageUpdatesAsync

Article
11/09/2023

Downloads updates for the specified packages without installing them. This allows your game to control when the install of the updates happen to prevent the game from shutting down while the user is playing.

Syntax

HRESULT XStoreDownloadPackageUpdatesAsync(  
         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 identifiers. A package identifier is a unique id string for a Microsoft store package. 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

Returns S_OK if successful; otherwise, returns an error code.

Remarks

This function only downloads and update but does not install it. In order to download and install an update in one call use the XStoreDownloadAndInstallPackageUpdatesAsync function. To retrieve the result of this function call XStoreDownloadPackageUpdatesResult 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