XStoreEnumerateProductsQuery

Article
06/22/2023

Enumerates the results of a products query.

Syntax

HRESULT XStoreEnumerateProductsQuery(  
         const XStoreProductQueryHandle productQueryHandle,  
         void* context,  
         XStoreProductQueryCallback* callback  
)

Parameters

productQueryHandle _In_
Type: XStoreProductQueryHandle

The handle of the query to enumerate the results of. XStoreProductQueryHandle is returned by XStoreQueryProductForCurrentGameResult, XStoreQueryProductForPackageResult.md, XStoreQueryEntitledProductsResult, XStoreQueryAssociatedProductsAsync, and XStoreQueryProductsResult.

context _In_opt_
Type: void*

Game defined context to pass to callback.

callback _In_
Type: XStoreProductQueryCallback*

Game define callback to be called for each product.

Return value

Type: HRESULT

HRESULT success or error code.

Remarks

This function is safe to call on a time-sensitive thread.

This function is used to enumerate products returned by a function that requests product information. Once you have called for the enumeration of products use the XStoreProductsQueryHasMorePages function to check for further product information. If there is more product information to be read then use XStoreProductsQueryNextPageAsync to read it. See XStoreQueryAssociatedProductsAsync for a usage example.

Requirements

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

Library: xgameruntime.lib

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

Share via