XGameSaveReadBlobDataResult

Article
06/22/2023

Retrieves the results of a XGameSaveReadBlobDataAsync call.

Syntax

HRESULT XGameSaveReadBlobDataResult(  
         XAsyncBlock* async,  
         size_t blobsSize,  
         XGameSaveBlob* blobData,  
         uint32_t* countOfBlobs  
)

Parameters

async _In_
Type: XAsyncBlock*

AsyncBlock passed from the XGameSaveReadBlobDataAsync function.

blobsSize _In_
Type: size_t

Required size of the allocated blob data. Retrieve via GetAsyncResultSize.

blobData _Out_writes_bytes_(blobsSize)
Type: XGameSaveBlob*

XGameSaveBlob pointer to contain the blob data. Must have memory allocated to store all of the blobs in the container.

countOfBlobs _Out_
Type: uint32_t*

Number of blobs returned in the result.

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

Call this function after XGameSaveReadBlobDataAsync is completed as a part of the callback function to verify success and retrieve the XGameSaveBlob data as well as the count of blobs. You can use these values in order to iterate over the blobs in a container to read the appropriate information. Result methods are commonly written in line with the asynchronous call which will call them later, but can also be written as separate functions.

See the XGameSaveReadBlobDataSync example for usage.

Requirements

Header: XGameSave.h

Library: xgameruntime.lib

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

Share via