XGameSaveFilesGetFolderWithUiAsync

  • Article

Returns a folder that can be used to contain directories and files for storage.

Syntax

HRESULT XGameSaveFilesGetFolderWithUiAsync(
  XUserHandle requestingUser,
  const char * configurationId,
  XAsyncBlock * async
)

Parameters

requestingUser
Type: In XUserHandle

Handle to an Xbox Live user.

configurationId
Type: In_z const char *

Service configuration ID (SCID).

async
Type: In XAsyncBlock *

Contains the information for the Async call.

Return value

Type: HRESULT

Function result.

Remarks

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.

When a game is resumed, developers should call XGameSaveFilesGetFolderWithUiAsync in order to ensure that save data is completely up-to-date.

Requirements

Header: XGameSaveFiles.h

See also

XGameSaveFiles members
Win32 file IO with Game Saves (XGameSaveFiles)