Microsoft.Xbox.Wrappers.XGameSave.Provider.Initialize

2025-04-28

Intializes the save game wrapper, and synchronizes all of the containers for the specified user.

Syntax

HRESULT Initialize(XUserHandle userHandle,
                   const std::string& serviceConfigurationId);

Parameters

userHandle _In_
Type: XUserHandle

A handle to the Xbox Live User account.

serviceConfigurationId _In_
Type: std::string

The game's Service Configuration ID (SCID).

Return value

Type: HRESULT

This method returns S_OK upon success, and the following HRESULT codes upon failure:

E_GS_USER_CANCELED
E_GS_USER_NOT_REGISTERED_IN_SERVICE
E_GS_NO_ACCESS
E_GS_NO_SERVICE_CONFIGURATION

Remarks

You must call this method before you can call any other method from the Provider class.

You shouldn't call this method on the game's UI thread because it can block, and then potentially show UI to the user as it synchronizes their game saves.

To load the data from the given blob, from the specified container, call Load.

Requirements

Header: xgamesavewrappers.hpp

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

Share via