> ## Documentation Index
> Fetch the complete documentation index at: https://devdocs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# XPersistentLocalStorageGetSpaceInfo

> XPersistentLocalStorageGetSpaceInfo

# XPersistentLocalStorageGetSpaceInfo

返回一个 [XPersistentLocalStorageSpaceInfo](/reference/system/xpersistentlocalstorage/structs/xpersistentlocalstoragespaceinfo) 结构，其中包含存储空间详细信息，例如
可用空间。

<a id="syntaxSection" />

## 语法

```cpp theme={null}
HRESULT XPersistentLocalStorageGetSpaceInfo(
         XPersistentLocalStorageSpaceInfo* info
)
```

<a id="parametersSection" />

### 参数

*info*   \_Out\_\
类型：[XPersistentLocalStorageSpaceInfo\*](/reference/system/xpersistentlocalstorage/structs/xpersistentlocalstoragespaceinfo)

`XPersistentLocalStorageSpaceInfo` 结构，用于存储存储空间详细信息。

<a id="retvalSection" />

### 返回值

类型：[HRESULT](https://learn.microsoft.com/openspecs/windows_protocols/ms-erref/0642cb2f-2075-4469-918c-4441e69c548a)

如果成功，则返回 **S\_OK**；否则返回错误代码。有关错误代码列表，请参阅[错误代码](/reference/errorcodes)。

<a id="remarksSection" />

## 备注

如果你的游戏使用可扩展永久本地存储 (GPLS)，请使用此函数来确定有多少可用存储空间。

存储详细信息包含在 [XPersistentLocalStorageSpaceInfo](/reference/system/xpersistentlocalstorage/structs/xpersistentlocalstoragespaceinfo) 结构中。

存储详细信息包括已使用的空间量、游戏可用的空间量以及是否应提示用户
释放空间。

请注意，调用
[GetDiskFreeSpaceExW](https://learn.microsoft.com/windows/win32/api/fileapi/nf-fileapi-getdiskfreespaceexw)
只会告诉游戏 PLS 中剩余的最大可用空间量 —— 不保证这些空间
可用。
[XPersistentLocalStorageGetSpaceInfo](/reference/system/xpersistentlocalstorage/functions/xpersistentlocalstoragegetspaceinfo) 还将返回
总可用空间以及有效可用空间（可用空间与底层驱动器实际
空间中的最小值）。

<a id="requirementsSection" />

## 要求

**头文件：** XPersistentLocalStorage.h

**库：** xgameruntime.lib

**支持的平台：** Windows、XBOX One 系列主机和 XBOX Series 主机

<a id="seealsoSection" />

## 概念文档

* [XBOX 主机上的本地存储](/build/console-features/storage/local-storage)

## 另请参阅

[XPersistentLocalStorage](/reference/system/xpersistentlocalstorage/xpersistentlocalstorage_members)\
[XPersistentLocalStorageSpaceInfo](/reference/system/xpersistentlocalstorage/structs/xpersistentlocalstoragespaceinfo)


## Related topics

- [XPersistentLocalStorageSpaceInfo](/zh-CN/reference/system/xpersistentlocalstorage/structs/xpersistentlocalstoragespaceinfo.md)
- [XPersistentLocalStorage](/zh-CN/reference/system/xpersistentlocalstorage/xpersistentlocalstorage_members.md)
- [XPersistentLocalStoragePromptUserForSpaceResult](/zh-CN/reference/system/xpersistentlocalstorage/functions/xpersistentlocalstoragepromptuserforspaceresult.md)
- [XPersistentLocalStoragePromptUserForSpaceAsync](/zh-CN/reference/system/xpersistentlocalstorage/functions/xpersistentlocalstoragepromptuserforspaceasync.md)
- [面向 GDK 的 Unity C# API 包装器](/zh-CN/build/gdk-and-engines/unity/unity-api-wrappers.md)