EOS_PlayerDataStorage_QueryFileList

EOS API reference page for EOS_PlayerDataStorage_QueryFileList

Choose your implementation method:

C

C#

This function is part of the PlayerDataStorage Interface.

Remarks

Query the file metadata, such as file names, size, and a MD5 hash of the data, for all files owned by this user for this application. This is not required before a file may be opened, saved, copied, or deleted.

See Also

EOS_PlayerDataStorage_GetFileMetadataCount, EOS_PlayerDataStorage_CopyFileMetadataAtIndex, EOS_PlayerDataStorage_CopyFileMetadataByFilename

Parameters

EOS_PlayerDataStorage_QueryFileList

Parameter Type And Name

Usage Information

EOS_HPlayerDataStorage Handle

const EOS_PlayerDataStorage_QueryFileListOptions* QueryFileListOptions

Object containing properties related to which user is querying files

void* ClientData

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

const EOS_PlayerDataStorage_OnQueryFileListCompleteCallback CompletionCallback

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

Callback Remarks

Callback for when EOS_PlayerDataStorage_QueryFileList completes

Callback Parameters

EOS_PlayerDataStorage_OnQueryFileListCompleteCallback

Parameter Type And Name

Usage Information

const EOS_PlayerDataStorage_QueryFileListCallbackInfo* Data

Related API Members

This function is part of the PlayerDataStorage Interface.

Remarks

Query the file metadata, such as file names, size, and a MD5 hash of the data, for all files owned by this user for this application. This is not required before a file may be opened, saved, copied, or deleted.

See Also

{GetFileMetadataCount}, {CopyFileMetadataAtIndex}, {CopyFileMetadataByFilename}

Parameters

PlayerDataStorage.PlayerDataStorageInterface.QueryFileList

Parameter Type And Name

Usage Information

QueryFileListOptions queryFileListOptions

Object containing properties related to which user is querying files

object clientData

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

OnQueryFileListCompleteCallback completionCallback

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

Callback Remarks

Callback for when {PlayerDataStorageInterface.QueryFileList} completes

Callback Parameters

PlayerDataStorage.OnQueryFileListCompleteCallback

Parameter Type And Name

Usage Information

QueryFileListCallbackInfo data

Related API Members