XblTitleStorageDownloadBlobAsync
Downloads blob data from title storage.
Syntax
HRESULT XblTitleStorageDownloadBlobAsync(
XblContextHandle xboxLiveContext,
XblTitleStorageBlobMetadata blobMetadata,
uint8_t* blobBuffer,
size_t blobBufferCount,
XblTitleStorageETagMatchCondition etagMatchCondition,
const char* selectQuery,
size_t preferredDownloadBlockSize,
XAsyncBlock* async
)
Parameters
xboxLiveContext _In_
Type: XblContextHandle
An xbox live context handle created with XblContextCreateHandle.
blobMetadata _In_
Type: XblTitleStorageBlobMetadata
The blob metadata for the title storage blob to download.
blobBuffer _Out_writes_(blobBufferCount)
Type: uint8_t*
A caller allocated buffer that passes back the downloaded blob data. This buffer needs to be large enough to store the blob being downloaded. If necessary, the length required for the buffer can be retrieved by getting the blob metadata.
blobBufferCount _In_
Type: size_t
The length of blobBuffer.
etagMatchCondition _In_
Type: XblTitleStorageETagMatchCondition
The ETag match condition used to determine if the blob should be downloaded.
selectQuery _In_opt_z_
Type: char*
ConfigStorage filter string or JSONStorage json property name string to filter. (Optional)
preferredDownloadBlockSize _In_
Type: size_t
The preferred download block size in bytes for binary blobs. Pass 0 to use the default size. (Optional)
async _In_
Type: XAsyncBlock*
Caller allocated AsyncBlock.
Return value
Type: HRESULT
HRESULT return code for this API operation.
Remarks
To get the result, call XblTitleStorageDownloadBlobResult inside the AsyncBlock callback or after the AsyncBlock is complete. This method will return E_NOT_SUFFICIENT_BUFFER (0x8007007A) if the blobBuffer doesn't have enough capacity to hold the blob data.
REST Call
V1 GET trustedplatform/users/xuid({xuid})/scids/{scid}/data/{path},{type}
V1 GET json/users/xuid({xuid})/scids/{scid}/data/{path},{type}
V1 GET global/scids/{scid}/data/{path},{type}
V1 GET sessions/{sessionId}/scids/{scid}/data/{path},{type}
Requirements
Header: title_storage_c.h
Library: Microsoft.Xbox.Services.141.GSDK.C.lib