Skip to main content

XStoreQueryEntitledProductsAsync

Returns store information for all products related to the current game that the user is entitled to.

Syntax

Parameters

storeContextHandle   _In_
Type: XStoreContextHandle
The store context handle for the user returned by XStoreCreateContext. productKinds   _In_
Type: XStoreProductKind
The kind of products to query. maxItemsToRetrievePerPage   _In_
Type: uint32_t
Maximum number of items to retrieve per page. The number of items returned per page can vary from 0 to maxItemsToRetrievePerPage. 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. For more information, see XAsyncBlock.

Return value

Type: HRESULT S_OK on success; otherwise, returns an error code.

Remarks

Call XStoreQueryEntitledProductsResult to retrieve the store product information and the execution result of this function. Execute XStoreQueryEntitledProductsResult in the callback function for XStoreQueryEntitledProductsAsync. The result contains an XStoreProductQueryHandle that you can enumerate by calling XStoreEnumerateProductsQuery.
The more items a player is entitled to, the longer this API can take to return.This API supports the same paging pattern described in XStoreQueryAssociatedProductsAsync.Paging can behave differently between sandboxes and RETAIL. Verify your paging implementation and be sure to test in RETAIL before release.For more information, see Paging.
You can’t know the number of products returned by this query upfront. The following code snippet provides an example of querying for a user’s entitlements to content related to the current game. Results are processed across multiple pages.

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
XStoreQueryEntitledProductsResult XStoreQueryAssociatedProductsAsync
XStoreQueryEntitledProductsAsync
XStoreQueryProductsAsync
XStoreQueryProductForCurrentGameAsync
XStoreQueryProductForPackageAsync
Basic store operations
Granting players access to add-on content
Last modified on October 19, 2026