EOS_PlayerDataStorage_DeleteCache

EOS API reference page for EOS_PlayerDataStorage_DeleteCache

実装方法を選んでください。

C

C#

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

Remarks

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

Parameters

EOS_PlayerDataStorage_DeleteCache

Parameter Type And Name

Usage Information

EOS_HPlayerDataStorage Handle

const EOS_PlayerDataStorage_DeleteCacheOptions* Options

Object containing properties related to which user is deleting cache

void* ClientData

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

const EOS_PlayerDataStorage_OnDeleteCacheCompleteCallback CompletionCallback

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

Callback Remarks

Callback for when EOS_PlayerDataStorage_DeleteCache completes

Callback Parameters

EOS_PlayerDataStorage_OnDeleteCacheCompleteCallback

Parameter Type And Name

Usage Information

const EOS_PlayerDataStorage_DeleteCacheCallbackInfo* Data

Related API Members

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

Remarks

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

Parameters

PlayerDataStorage.PlayerDataStorageInterface.DeleteCache

Parameter Type And Name

Usage Information

DeleteCacheOptions options

Object containing properties related to which user is deleting cache

object clientData

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

OnDeleteCacheCompleteCallback completionCallback

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

Callback Remarks

Callback for when EOS_PlayerDataStorage_DeleteCache completes

Callback Parameters

PlayerDataStorage.OnDeleteCacheCompleteCallback

Parameter Type And Name

Usage Information

DeleteCacheCallbackInfo data

Related API Members