XGameSaveEnumerateBlobInfoByName

Article
06/22/2023

Retrieves the blob info for the contents of a XGameSaveContainer limited to the blobs which share a prefix with the blobNamePrefix parameter.

Syntax

HRESULT XGameSaveEnumerateBlobInfoByName(  
         XGameSaveContainerHandle container,  
         const char* blobNamePrefix,  
         void* context,  
         XGameSaveBlobInfoCallback* callback  
)

Parameters

container _In_
Type: XGameSaveContainerHandle

Handle to the XGameSaveContainer containing the blobs to be enumerated.

blobNamePrefix _In_opt_z_
Type: char*

prefix used to filter blobs retrieved.

context _In_opt_
Type: void*

Pointer to the calling object for context.

callback _In_
Type: XGameSaveBlobInfoCallback*

Function to be called for every blob that matches the prefix, return false to stop the enumeration.. Use this to iterate over the XGameSaveBlobInfo and verify success of the function call.

Return value

Type: HRESULT

Function result.

Remarks

Note

While this function is safe to call on a time-sensitive thread, the XGameSaveBlobInfoCallback may cause delays, depending on what the title does within the callback. As an example, copying data from the callback is fine; however, doing any non-time sensitive call can delay the callbacks return. For more information, see Time-sensitive threads.

Blobs contain the actual retrievable data that makes up a container. Enumerating blobs will allow you to see all of the data available inside of the container. You can use XGameSaveEnumerateBlobInfo to enumerate all the blobs of a container instead of filtering by a prefix.

Requirements

Header: XGameSave.h

Library: xgameruntime.lib

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

Share via