XStoreGetUserCollectionsIdResult

Article
06/22/2023

Gets the results of a call to XStoreGetUserCollectionsIdAsync.

Syntax

HRESULT XStoreGetUserCollectionsIdResult(  
         XAsyncBlock* async,  
         size_t size,  
         char* result  
)

Parameters

async _Inout_
Type: XAsyncBlock*

The XAsyncBlock passed to XStoreGetUserCollectionsIdAsync. The XAsyncBlock can be used to poll for the call's status and retrieve call results. See XAsyncBlock for more information.

size _In_
Type: size_t

The size of the array passed into result.

result _Out_writes_z_(size)
Type: char*

On success contains the collections ID.

Return value

Type: HRESULT

HRESULT success or error code.

Remarks

This result function allows you to retrieve the execution results of XStoreGetUserCollectionsIdAsync, as well as the collections ID that was called for if the execution was successful. As such, this function should be called after XStoreGetUserCollectionsIdAsync has been called, usually in the context of a callback function. See XStoreGetUserCollectionsIdAsync 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