Skip to main content

XGameSaveGetContainerInfo

Retrieves info for the containers in an XGameSaveProvider.

Syntax

Parameters

provider   _In_
Type: XGameSaveProviderHandle
An XGameSaveProvider handle with the desired container. containerName   _In_z_
Type: char*
Name of container to retrieve info about, will return only one result if found. If more than one container is desired use XGameSaveEnumerateContainerInfo or XGameSaveEnumerateContainerInfoByName. context   _In_opt_
Type: void*
Pointer to the calling object for context. callback   _In_
Type: XGameSaveContainerInfoCallback*
Callback function to determine the results of and collect data from the XGameSaveContainerInfo call.

Return value

Type: HRESULT Function result

Common errors

  • E_GS_INVALID_CONTAINER_NAME
  • E_GS_USER_CANCELED
  • E_GS_CONTAINER_NOT_IN_SYNC
  • E_GS_CONTAINER_SYNC_FAILED
  • E_GS_HANDLE_EXPIRED

Remarks

This function isn’t safe to call on a time-sensitive thread. For more information, see Time-sensitive threads.
A container is a collection of metadata and a reference point for the set of blobs within it. If the container name is known ahead of time it is possible to use this API to return the information for just that container. This is useful for bringing back specific information about a player instead of calling for all of it each time you need information. You can find the make up of an XGameSaveContainer in the XGameSaveContainerInfo struct.

Requirements

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

Conceptual documentation

See also

XGameSave
XGameSaveCreateContainer
XGameSaveContainerInfo
Debugging Game Saves
Last modified on August 20, 2026