EOS_TitleStorage_ReadFile

EOS API reference page for EOS_TitleStorage_ReadFile

3 mins to read

This function is part of the TitleStorage Interface.

Remarks

Retrieve the contents of a specific file, potentially downloading the contents if we do not have a local copy, from the cloud. This request will occur asynchronously, potentially over multiple frames. All callbacks for this function will come from the same thread that the SDK is ticked from. If specified, the FileTransferProgressCallback will always be called at least once if the request is started successfully.

Return Value

A valid Title Storage File Request handle if successful, or NULL otherwise. Data contained in the completion callback will have more detailed information about issues with the request in failure cases. This handle must be released when it is no longer needed

See Also

EOS_TitleStorageFileTransferRequest_Release

Parameters

EOS_TitleStorage_ReadFile

Parameter Type And NameUsage Information
EOS_HTitleStorage Handle
const EOS_TitleStorage_ReadFileOptions* OptionsObject containing properties related to which user is opening the file, what the file's name is, and related mechanisms for copying the data
void* ClientDataOptional pointer to help clients track this request, that is returned in associated callbacks
const EOS_TitleStorage_OnReadFileCompleteCallback CompletionCallbackThis function is called when the read operation completes

Callback Function Information

Because this function is asynchronous, it employs a callback of type EOS_TitleStorage_OnReadFileCompleteCallback to report the results of its operation.

Callback Remarks

Callback for when EOS_TitleStorage_ReadFile completes

Callback Parameters

EOS_TitleStorage_OnReadFileCompleteCallback

Parameter Type And NameUsage Information
const EOS_TitleStorage_ReadFileCallbackInfo* Data