Skip to main content

XStoreQueryAddOnLicensesAsync

Enumerates the licenses of any Durable add-ons that are attached to a digital game license. This applies solely to Durable without package types and can only be used with a digital license, not disc licenses. Running this with a disc license will result in empty results, even if there exist individual durables that are owned or licensable by the user. For disc scenarios, use XStoreAcquireLicenseForDurablesAsync instead.

Syntax

Parameters

storeContextHandle   _In_
Type: XStoreContextHandle
The store context handle for the user returned by XStoreCreateContext. 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

To retrieve the add-on license as well as the execution result of this function call XStoreQueryAddonLicensesResult after calling this function. To retrieve the number of licenses obtained by this function call XStoreQueryAddonLicensesResultCount after calling this function. The result count function is important as it will allow you to determine the appropriate size of array to pass to the result function. The following code snippet shows an example of retrieving Durable add-on licenses (without package) the user owns or can license:

Requirements

Header: XStore.h (included in XGameRuntime.h) Library: xgameruntime.lib Supported platforms: Windows, XBOX One family consoles and XBOX Series consoles

Conceptual documentation

See also

XStore
XStoreQueryAddonLicensesResult
XStoreQueryAddonLicensesResultCount
Last modified on August 20, 2026