Share via

XPersistentLocalStorageSpaceInfo

  • Article

Contains details about the state of Persistent Local Storage (PLS), returned by XPersistentLocalStorageGetSpaceInfo.

Syntax

typedef struct XPersistentLocalStorageSpaceInfo {
    uint64_t availableFreeBytes;
    uint64_t totalFreeBytes;
    uint64_t usedBytes;
    uint64_t totalBytes;
} XPersistentLocalStorageSpaceInfo

Members

availableFreeBytes
Type: uint64_t

The amount of available storage space, in bytes.

totalFreeBytes
Type: uint64_t

The amount of space left after PLS allocation. You might have to prompt the user to free up space to make these bytes available. For more information, see XPersistentLocalStoragePromptUserForSpaceAsync.

usedBytes
Type: uint64_t

The amount of storage space currently in use, in bytes.

totalBytes
Type: uint64_t

The total amount of storage space (in bytes) that the user can use.

Remarks

If your title uses Growable Persistent Local Storage, then you can call the XPersistentLocalStorageGetSpaceInfo function to determine how much storage space is available.

When the XPersistentLocalStorageGetSpaceInfo function call returns, check the XPersistentLocalStorageSpaceInfo object for the storage details.

Storage details include the amount of space in use, how much is available to the title, and whether the user should be prompted to free up space.

Requirements

Header: XPersistentLocalStorage.h

Library: xgameruntime.lib

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

See also

XPersistentLocalStorage
XPersistentLocalStorageGetSpaceInfo
XPersistentLocalStoragePromptUserForSpaceAsync.