EOS API reference page for EOS_PlayerDataStorage_DeleteCache

3 분 소요

This function is part of the PlayerDataStorage Interface.


Clear previously cached file data. This operation will be done asynchronously. All cached files except those corresponding to the transfers in progress will be removed. Warning: Use this with care. Cache system generally tries to clear old and unused cached files from time to time. Unnecessarily clearing cache can degrade performance as SDK will have to re-download data.

Return Value

EOS_Success if the operation was started correctly, otherwise an error result explaining what went wrong



Parameter Type And NameUsage Information
EOS_HPlayerDataStorage Handle
const EOS_PlayerDataStorage_DeleteCacheOptions* OptionsObject containing properties related to which user is deleting cache
void* ClientDataOptional pointer to help clients track this request, that is returned in associated callbacks
const EOS_PlayerDataStorage_OnDeleteCacheCompleteCallback CompletionCallbackThis function is called when the delete cache operation completes

Callback Function Information

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

Callback Remarks

Callback for when EOS_PlayerDataStorage_DeleteCache completes

Callback Parameters


Parameter Type And NameUsage Information
const EOS_PlayerDataStorage_DeleteCacheCallbackInfo* Data