Skip to main content

XGameSaveInitializeProviderAsync

Provides and initializes an XGameSave Provider handle asynchronously.

Syntax

Parameters

requestingUser   _In_
Type: XUserHandle
Handle to an XBOX Live User. configurationId   _In_z_
Type: char*
Service configuration ID (SCID). syncOnDemand   _In_
Type: bool
When true syncOnDemand only downloads data from the service if needed. Does not work if device is offline. Setting to true may cause sync progress UI to be shown. async   _In_
Type: XAsyncBlock*
Contains the information for the Async call. This includes calling context and a call to the XGameSaveInitializeProviderResult function.

Return value

Type: HRESULT Function result.

Remarks

This function must be called successfully before other XGameSave APIs are used.
The XGameSave API requires your title to have its title ID and service configuration ID (SCID)
properly configured in order to work. For more information about these required IDs, see Setting Up Sandboxes for XBOX Live Development. Your game must be enabled for XBOX Live in Partner Center.
If you do not configure your SCID and Title ID properly, your XSaveGame API calls will fail with the following error code: E_GS_NO_ACCESS - 0x80830002 - The operation failed because the title does not have access to the container storage spaces. The resulting XGameSaveProviderHandle is obtained from the XGameSaveInitializeProviderResult function. This is the handle you will use to access your XGameSaveProvider. When this API is called with syncOnDemand set to true it behaves the same from a caller perspective but it does cause some behavior differences in the rest of the API. The SyncOnDemand XGameSaveProvider will only download data from the service if needed but this also comes with the drawback that any container operation might be delayed in this case and this delay may cause some UX to be shown to the user for the sync progress. Using any of the following methods can force a sync: Another drawback would be that if the device is offline or has connectivity issues then accessing the container is impossible. ##Example
Games cannot mix the usage of XGameSaveFiles with the usage of XGameSave. Games much choose which cloud save system they want to use. If the game is using XGameSaveFiles and later calls XGameSaveInitializeProvider, it will error out with E_GS_PROVIDER_MISMATCH. Equally, if the game was using XGameSave and later calls XGameSaveFilesGetFolderWithUiAsync, that will also error out with E_GS_PROVIDER_MISMATCH.

Requirements

Header: XGameSave.h Library: xgameruntime.lib Supported platforms: Windows, XBOX One family consoles and XBOX Series consoles

Conceptual documentation

See also

XGameSave
XGameSaveInitializeProviderResult
XGameSaveInitializeProvider
Debugging Game Saves
Last modified on August 20, 2026