XStoreProductsQueryHasMorePages

Article
06/22/2023

Checks if there are more results pages for the specified query. This is essential to call for XStoreQuery APIs, especially those that are expected to return multiple results, such as XStoreQueryAssociatedProductsAsync.

Syntax

bool XStoreProductsQueryHasMorePages(  
         const XStoreProductQueryHandle productQueryHandle  
)

Parameters

productQueryHandle _In_
Type: XStoreProductQueryHandle

The handle to the query to check for more pages. On the first call to XStoreProductsQueryHasMorePages, this will be the XStoreProductQueryHandle returned by XStoreQueryProductForCurrentGameResult, XStoreQueryProductForPackageResult, XStoreQueryEntitledProductsResult, or XStoreQueryProductsResult. On subsequent calls, the query handle returned by XStoreProductsQueryNextPageResult should be used.

Return value

Type: bool

Returns true if there are more results pages to display.

Remarks

This function is used to check to see if a product query has additional pages of product information. It is called after a product query has been enumerated with XStoreEnumerateProductsQuery. If this function returns true there is more product query information to be read. Call XStoreProductsQueryNextPageAsync to read additional product query information. 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