EOS_PlayerDataStorage_ReadFile

EOS API reference page for EOS_PlayerDataStorage_ReadFile

Choose your implementation method:

C

C#

This function is part of the PlayerDataStorage 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 Player Data 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_PlayerDataStorageFileTransferRequest_Release

Parameters

EOS_PlayerDataStorage_ReadFile

Parameter Type And Name

Usage Information

EOS_HPlayerDataStorage Handle

const EOS_PlayerDataStorage_ReadFileOptions* ReadOptions

Object containing properties related to which user is opening the file, what the file's name is, and related mechanisms for copying the data

void* ClientData

Optional pointer to help clients track this request, that is returned in associated callbacks

const EOS_PlayerDataStorage_OnReadFileCompleteCallback CompletionCallback

This function is called when the read operation completes

This function is asynchronous; the EOS SDK guarantees that your callback (the CompletionCallback parameter) will run when the operation completes, regardless of whether it succeeds or fails. Use the void* parameter to pass any contextual information the callback may need in order to react properly. Relevant information can be copied from the EOS SDK's cache while the callback function is running. You do not need to remove the callback function.

Callback Function Information

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

Callback Remarks

Callback for when EOS_PlayerDataStorage_ReadFile completes

Callback Parameters

EOS_PlayerDataStorage_OnReadFileCompleteCallback

Parameter Type And Name

Usage Information

const EOS_PlayerDataStorage_ReadFileCallbackInfo* Data

Related API Members

This function is part of the PlayerDataStorage 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 Player Data 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

{PlayerDataStorageFileTransferRequest.Release}

Parameters

PlayerDataStorage.PlayerDataStorageInterface.ReadFile

Parameter Type And Name

Usage Information

ReadFileOptions readOptions

Object containing properties related to which user is opening the file, what the file's name is, and related mechanisms for copying the data

object clientData

Optional pointer to help clients track this request, that is returned in associated callbacks

OnReadFileCompleteCallback completionCallback

This function is called when the read operation completes

This function is asynchronous; the EOS SDK guarantees that your callback (the CompletionCallback parameter) will run when the operation completes, regardless of whether it succeeds or fails. Use the object parameter to pass any contextual information the callback may need in order to react properly. Relevant information can be copied from the EOS SDK's cache while the callback function is running. You do not need to remove the callback function.

Callback Function Information

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

Callback Remarks

Callback for when {PlayerDataStorageInterface.ReadFile} completes

Callback Parameters

PlayerDataStorage.OnReadFileCompleteCallback

Parameter Type And Name

Usage Information

ReadFileCallbackInfo data

Related API Members