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

# XGameSaveInitializeProviderAsync

> XGameSaveInitializeProviderAsync

# XGameSaveInitializeProviderAsync

以非同步方式提供並初始化 XGameSave 提供者控制代碼。

## 語法

```cpp theme={null}
HRESULT XGameSaveInitializeProviderAsync(  
         XUserHandle requestingUser,  
         const char* configurationId,  
         bool syncOnDemand,  
         XAsyncBlock* async  
)  
```

### 參數

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

XBOX Live 使用者的控制代碼。

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

服務設定識別碼 (SCID)。

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

為 true 時，syncOnDemand 只會在需要時從服務下載資料。裝置離線時無法運作。
設定為 true 可能會導致顯示同步進度 UI。

*async*   \_In\_\
類型：[XAsyncBlock\*](/zh-TW/reference/system/xasync/structs/xasyncblock)

包含非同步呼叫的資訊。這包括呼叫內容，以及對
[XGameSaveInitializeProviderResult](/zh-TW/reference/system/xgamesave/functions/xgamesaveinitializeproviderresult) 函式的呼叫。

### 傳回值

類型：HRESULT

函式結果。

## 備註

必須先成功呼叫此函式，才能使用其他 XGameSave API。

<Note>XGameSave API 需要您的遊戲正確設定其遊戲識別碼和服務設定識別碼 (SCID)</Note>
才能運作。如需這些必要識別碼的詳細資訊，請參閱[設定 XBOX
Live 開發的沙箱](/zh-TW/services/xbox-services/fundamentals/sandboxes/live-setting-up-sandboxes)。您的遊戲必須在 Partner Center 中啟用 XBOX Live。

如果您未正確設定 SCID 和遊戲識別碼，您的 XSaveGame API 呼叫將會失敗並傳回下列錯誤碼：

E\_GS\_NO\_ACCESS - 0x80830002 - 作業失敗，因為遊戲沒有容器儲存空間的存取權。

產生的 **XGameSaveProviderHandle** 可從
[XGameSaveInitializeProviderResult](/zh-TW/reference/system/xgamesave/functions/xgamesaveinitializeproviderresult) 函式取得。這是您用來
存取 **XGameSaveProvider** 的控制代碼。

以 *syncOnDemand* 設為 true 呼叫此 API 時，從呼叫端的角度來看行為相同，但會造成
API 其餘部分的一些行為差異。*SyncOnDemand* **XGameSaveProvider** 只會在需要時從服務下載資料，
但這也伴隨著缺點：在此情況下任何容器作業都可能延遲，
而此延遲可能會導致向使用者顯示同步進度的 UX。使用下列任何方法都可能
強制同步：

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

另一個缺點是，如果裝置離線或有連線問題，就無法存取容器。

\##範例

```cpp theme={null}
// ASYNC Init - can be kicked off from a time sensitive thread 
//              work and callback will happen from platform provided threads 
void Sample::_InitializeAsync() 
{ 
    HRESULT hr; 
  
    struct InitContext 
    { 
        Sample* self; 
        XAsyncBlock async; 
    }; 
  
    InitContext* ctx = new InitContext{}; 
    if (ctx) 
    { 
        ctx->self = this; 
        ctx->async.context = ctx; 
        ctx->async.callback = [](XAsyncBlock* async) 
        { 
            auto ctx = reinterpret_cast<InitContext*>(async->context); 
            auto self = ctx->self; 
            XGameSaveProviderHandle provider = nullptr; 
            HRESULT hr = XGameSaveInitializeProviderResult(async, &provider); 
            if (SUCCEEDED(hr)) 
            { 
                self->_provider = provider; 
            } 
            else 
            { 
                self->_HandleInitializeErrors(self->_xalUser, hr); 
            } 
            delete ctx; 
        }; 
    } 
    else 
    { 
        hr = E_OUTOFMEMORY; 
    } 
  
    if (SUCCEEDED(hr)) 
    { 
        hr = XGameSaveInitializeProviderAsync(this->_xalUser, "SERVICE_CONFIG_ID-DEADBEEF0123", false, &ctx->async); 
    } 
    if (FAILED(hr)) 
    { 
        // if we didn't setup the async we need to cleanup our tracking context 
        delete ctx; 
        _HandleInitializeErrors(this->_xalUser, hr); 
    } 
} 
```

遊戲無法混合使用 XGameSaveFiles 與 XGameSave。遊戲必須選擇要使用哪一個雲端存檔系統。
如果遊戲使用 XGameSaveFiles，之後又呼叫 XGameSaveInitializeProvider，將會發生錯誤並傳回
E\_GS\_PROVIDER\_MISMATCH。同樣地，如果遊戲使用 XGameSave，之後又呼叫 XGameSaveFilesGetFolderWithUiAsync，
也會發生錯誤並傳回 E\_GS\_PROVIDER\_MISMATCH。

## 需求

**標頭：** XGameSave.h

**程式庫：** xgameruntime.lib

**支援的平台：** Windows、XBOX One 系列主機和 XBOX Series 主機

## 概念文件

* [非同步程式設計設計目標和改進](/zh-TW/build/core-features/common/async/async-whitepaper)
* [遊戲存檔工具](/zh-TW/build/core-features/common/game-save/game-saves-tools)

## 另請參閱

[XGameSave](/zh-TW/reference/system/xgamesave/xgamesave_members)\
[XGameSaveInitializeProviderResult](/zh-TW/reference/system/xgamesave/functions/xgamesaveinitializeproviderresult)\
[XGameSaveInitializeProvider](/zh-TW/reference/system/xgamesave/functions/xgamesaveinitializeprovider)\
[偵錯遊戲存檔](/zh-TW/build/core-features/common/game-save/game-saves-debugging)


## Related topics

- [XGameSaveInitializeProviderAsync](/reference/system/xgamesave/functions/xgamesaveinitializeproviderasync.md)
- [XGameSaveInitializeProviderResult](/reference/system/xgamesave/functions/xgamesaveinitializeproviderresult.md)
- [XGameSaveInitializeProvider](/reference/system/xgamesave/functions/xgamesaveinitializeprovider.md)