EOS_PlayerDataStorage_DuplicateFile

EOS API reference page for EOS_PlayerDataStorage_DuplicateFile

This function is part of the PlayerDataStorage Interface.

Remarks

Copies the data of an existing file to a new filename. This action happens entirely on the server and will not upload the contents of the source destination file from the host. This function paired with a subsequent EOS_PlayerDataStorage_DeleteFile can be used to rename a file. If successful, the destination file's metadata will be updated in our local cache.

Parameters

Parameter Type And Name

Usage Information

EOS_HPlayerDataStorage Handle

const EOS_PlayerDataStorage_DuplicateFileOptions* DuplicateOptions

Object containing properties related to which user is duplicating the file, and what the source and destination file names are

void* ClientData

Optional pointer to help clients track this request, that is returned in the completion callback

const EOS_PlayerDataStorage_OnDuplicateFileCompleteCallback CompletionCallback

This function is called when the duplicate 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_OnDuplicateFileCompleteCallback to report the results of its operation.

Callback Remarks

Callback for when EOS_PlayerDataStorage_DuplicateFile completes

Callback Parameters

Parameter Type And Name

Usage Information

const EOS_PlayerDataStorage_DuplicateFileCallbackInfo* Data

Related API Members