XGameSaveEnumerateContainerInfo

检索 XGameSaveProvider 的容器信息。

语法

HRESULT XGameSaveEnumerateContainerInfo(  
         XGameSaveProviderHandle provider,  
         void* context,  
         XGameSaveContainerInfoCallback* callback  
)  

参数

provider _In_
类型:XGameSaveProviderHandle

包含 XGameSaveContainerInfoXGameSaveProvider 的句柄。

context _In_opt_
类型:void*

将传递到回调函数中的指针。

callback _In_
类型:XGameSaveContainerInfoCallback*

要为每个容器运行的回调函数,返回 false 可停止枚举。 使用此函数可收集 XGameSaveContainerInfo。

返回值

类型:HRESULT

函数结果

备注

使用此函数可检查哪些容器适用于用户。 这可能包括在 UX 中显示所需的数据。 枚举此集合将不会导致针对 SyncOnDemand 提供程序的同步,并且将允许调用方通过 XGameSaveContainerInfo 的 needsSync 字段实际检查同步状态。 对于将 needsSync 设置为 true 的容器上更新上下文的 blob 数据或者用法的任何读取都将强制同步,并且可能会返回不同的同步错误。 您可以通过指定在返回容器的信息前必须匹配的前缀,使用 XGameSaveEnumerateContainerInfoByName 执行容器筛选。

要求

头文件:XGameSave.h

库:xgameruntime.lib

支持平台:Windows、Xbox One 系列主机和 Xbox Series 主机

另请参阅

XGameSave
XGameSaveEnumerateContainerInfoByName
XGameSaveContainerInfo
游戏保存错误