EOS_PlayerDataStorage_DeleteFile

EOS API reference page for EOS_PlayerDataStorage_DeleteFile

Choose your implementation method:

C

C#

This function is part of the [PlayerDataStorage Interface](Interfaces/PlayerDataStorage).

Remarks

Deletes an existing file in the cloud. If successful, the file's data will be removed from our local cache.

Parameters

EOS_PlayerDataStorage_DeleteFile

Parameter Type And Name

Usage Information

EOS_HPlayerDataStorage Handle

const EOS_PlayerDataStorage_DeleteFileOptions* DeleteOptions

Object containing properties related to which user is deleting the file, and what file name is

void* ClientData

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

const EOS_PlayerDataStorage_OnDeleteFileCompleteCallback CompletionCallback

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

Callback Remarks

Callback for when EOS_PlayerDataStorage_DeleteFile completes

Callback Parameters

EOS_PlayerDataStorage_OnDeleteFileCompleteCallback

Parameter Type And Name

Usage Information

const EOS_PlayerDataStorage_DeleteFileCallbackInfo* Data

Related API Members

This function is part of the [PlayerDataStorage Interface](Interfaces/PlayerDataStorage).

Remarks

Deletes an existing file in the cloud. If successful, the file's data will be removed from our local cache.

Parameters

PlayerDataStorage.PlayerDataStorageInterface.DeleteFile

Parameter Type And Name

Usage Information

DeleteFileOptions deleteOptions

Object containing properties related to which user is deleting the file, and what file name is

object clientData

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

OnDeleteFileCompleteCallback completionCallback

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

Callback Remarks

Callback for when EOS_PlayerDataStorage_DeleteFile completes

Callback Parameters

PlayerDataStorage.OnDeleteFileCompleteCallback

Parameter Type And Name

Usage Information

DeleteFileCallbackInfo data

Related API Members