Skip to main content

XGameSaveReadBlobData

Reads the blob data for a container.

Syntax

Parameters

container   _In_
Type: XGameSaveContainerHandle
Handle to the XGameSaveContainer containing the XGameSaveBlob data. blobNames   _In_opt_z_count_(countOfBlobs)
Type: char
*
Pointer to an array of strings representing the XGameSaveBlob names. countOfBlobs   _Inout_
Type: uint32_t*
Number of blobs to read. blobsSize   _In_
Type: size_t
Size of the allocated blob data, can be inferred from reading the blob metadata. blobData   _Out_writes_bytes_(blobsSize)
Type: XGameSaveBlob*
XGameSaveBlob pointer to contain the blob data. Must have memory allocated to store all of the blobs requested from the container.

Return value

Type: HRESULT Function result.

Common errors

  • E_GS_INVALID_CONTAINER_NAME
  • E_GS_PROVIDED_BUFFER_TOO_SMALL
  • E_GS_BLOB_NOT_FOUND
  • 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.
Use this function to read the data in a game save blob. The function will return the number of blobs and the data inside of a blob container. You can use these in order to iterate over the blobs in a container to read the appropriate information. There is an asynchronous version of this function called XGameSaveReadBlobDataAsync.

Requirements

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

Conceptual documentation

See also

XGameSave
XGameSaveBlobInfo
XGameSaveReadBlobDataAsync
Debugging Game Saves
Last modified on August 20, 2026