XPersistentLocalStoragePromptUserForSpaceResult

Returns the result of a call to the function XPersistentLocalStoragePromptUserForSpaceAsync.

Syntax

HRESULT XPersistentLocalStoragePromptUserForSpaceResult(
         XAsyncBlock* asyncBlock
)

Parameters

asyncBlock   _Inout_
Type: XAsyncBlock\d*

A pointer to an XAsyncBlock object, which you can use to monitor the status of the asynchronous call.

Return value

Type: HRESULT

Returns S_OK if the user attempted to free up the requested space; otherwise, returns an error code. For a list of error codes, see Error Codes. Returns E_ABORT if the user chooses not to attempt to free up space.

Remarks

The result of the async operation is success if the user chose to free up space. There is no guarantee that the user freed the requested number of bytes, only that they took action.

Your game should query free space again using XPersistentLocalStorageGetSpaceInfo when the user retries the operation that resulted in the space request.

The async operation results in E_ABORT if the user chooses not to free up space.

Since Persistent Local Storage is not implemented on the PC platform, don't use this function on that platform.

Requirements

Header: XPersistentLocalStorage.h

Library: xgameruntime.lib

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

See also

XPersistentLocalStorage
XPersistentLocalStorageGetSpaceInfo