> ## 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.

# XGameSaveInitializeProvider

> XGameSaveInitializeProvider

# XGameSaveInitializeProvider

提供并初始化 XGameSave Provider 句柄。

## 语法

```cpp theme={null}
HRESULT XGameSaveInitializeProvider(  
         XUserHandle requestingUser,  
         const char* configurationId,  
         bool syncOnDemand,  
         XGameSaveProviderHandle* provider  
)  
```

### 参数

*requestingUser*   \_In\_\
类型：XUserHandle

XBOX Live 用户的句柄。

*configurationId*   \_In\_z\_\
类型：char\*

服务配置 ID (SCID)。

*syncOnDemand*   \_In\_\
类型：bool

当为 true 时，syncOnDemand 仅在需要时从服务下载数据。如果设备处于离线状态，则不起作用。
设置为 true 可能会导致显示同步进度 UI。

*provider*   \_Outptr\_result\_nullonfailure\_\
类型：XGameSaveProviderHandle\*

要创建的 XGameSave Provider 的句柄。

### 返回值

类型：HRESULT

函数结果。

#### 常见错误

* E\_GS\_USER\_CANCELED
* E\_GS\_USER\_NOT\_REGISTERED\_IN\_SERVICE
* E\_GS\_NO\_ACCESS
* E\_GS\_NO\_SERVICE\_CONFIGURATION

最常返回的错误是 E\_OUTOFMEMORY、E\_INVALIDARG。

## 备注

<Note>在时间敏感线程上调用此函数并不安全。有关详细信息，请参阅[时间敏感线程](https://learn.microsoft.com/gaming/gdk/docs/gdk-dev/console-dev/overviews/threads/time-sensitive-threads)。</Note>

在使用其他 XGameSave API 之前，必须成功调用此函数。不应在游戏的 UI 线程上调用此函数，因为它可能会阻塞，并且在同步玩家的游戏保存时可能会向用户显示 UI。如果需要从 UI 线程初始化此函数，请考虑调用
[XGameSaveInitializeProviderAsync](/reference/system/xgamesave/functions/xgamesaveinitializeproviderasync)。

<Note>XGameSave API 要求你的游戏正确配置其游戏 ID 和服务配置 ID (SCID)</Note>
才能正常工作。有关这些必需 ID 的详细信息，请参阅[为 XBOX
Live 开发设置沙盒](/services/xbox-services/fundamentals/sandboxes/live-setting-up-sandboxes)。你的游戏必须在合作伙伴中心为 XBOX Live 启用。

如果你没有正确配置 SCID 和游戏 ID，则你的 XSaveGame API 调用将失败并返回以下错误代码：

E\_GS\_NO\_ACCESS - 0x80830002 - 由于游戏无权访问容器存储空间，因此操作失败。

当在调用此 API 时将 *syncOnDemand* 设置为 true 时，从调用方的角度看它的行为相同，但会导致 API 的其余部分出现
某些行为差异。*SyncOnDemand* **XGameSaveProvider** 仅在需要时从服务下载数据，但这也会带来一些缺点，即在这种情况下任何容器操作可能会延迟，
并且此延迟可能导致向用户显示某些 UX 以指示同步进度。使用以下任一方法都可以
强制同步：

* [XGameSaveCreateUpdate](/reference/system/xgamesave/functions/xgamesavecreateupdate)
* [XGameSaveEnumeratorBlobInfo](/reference/system/xgamesave/functions/xgamesaveenumerateblobinfo)
* [XGameSaveEnumerateBlobInfoByName](/reference/system/xgamesave/functions/xgamesaveenumerateblobinfobyname)
* [XGameSaveEnumerateContainerInfo](/reference/system/xgamesave/functions/xgamesaveenumeratecontainerinfo)
* [XGameSaveEnumerateContainerInfoByName](/reference/system/xgamesave/functions/xgamesaveenumeratecontainerinfobyname)

另一个缺点是，如果设备处于离线状态或存在连接问题，则无法访问容器。此函数还有一个异步版本
[XGameSaveInitializeProviderAsync](/reference/system/xgamesave/functions/xgamesaveinitializeproviderasync)。

```cpp theme={null}
// SYNC Init - should not be called on time sensitive thread 
//             as this will block until the operation is complete 
void Sample::_InitializeSync() 
{ 
    HRESULT hr; 
    XGameSaveProviderHandle provider = nullptr; 
    hr = XGameSaveInitializeProvider(this->_xalUser, "SERVICE_CONFIG_ID-DEADBEEF0123", false, &provider); 
    if (SUCCEEDED(hr)) 
    { 
        this->_provider = provider; 
    } 
    else 
    { 
        _HandleInitializeErrors(this->_xalUser, hr); 
    } 
} 
 
// handle initialization errors  
void Sample::_HandleInitializeErrors(XUserHandle userContext, HRESULT hr) 
{ 
    switch (hr) 
    { 
    case E_GS_USER_CANCELED: 
        printf("User %p canceled initialization hr=0x%08x\n", userContext, hr); 
        break; 
    case E_GS_USER_NOT_REGISTERED_IN_SERVICE: 
        printf("User %p has no service registration\n", userContext); 
        break; 
    /* NOTE These should only be seen if there is a configuration issue */ 
    case E_GS_NO_ACCESS: 
    case E_GS_NO_SERVICE_CONFIGURATION: 
        printf("Problems with Service Configuration registration\n"); 
        break; 
    case S_OK: 
        break; 
    default: 
        printf("Unknown initialization error for User %p hr=0x%08X\n", userContext, hr); 
    } 
} 
```

游戏不能混合使用 XGameSaveFiles 和 XGameSave。游戏必须选择要使用的云保存系统。
如果游戏正在使用 XGameSaveFiles 且随后调用 XGameSaveInitializeProvider，则将出错
并返回 E\_GS\_PROVIDER\_MISMATCH。同样，如果游戏正在使用 XGameSave 且随后调用 XGameSaveFilesGetFolderWithUiAsync，
也将出错并返回 E\_GS\_PROVIDER\_MISMATCH。

## 要求

**标头：** XGameSave.h

**库：** xgameruntime.lib

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

## 概念性文档

* [游戏保存工具](/build/core-features/common/game-save/game-saves-tools)
* [时间敏感线程](https://learn.microsoft.com/gaming/gdk/docs/gdk-dev/console-dev/overviews/threads/time-sensitive-threads)

## 另请参阅

[XGameSave](/reference/system/xgamesave/xgamesave_members)\
[XGameSaveInitializeProviderAsync](/reference/system/xgamesave/functions/xgamesaveinitializeproviderasync)\
[调试游戏保存](/build/core-features/common/game-save/game-saves-debugging)