EOS API reference page for EOS_PlayerDataStorage_QueryFile

This function is part of the PlayerDataStorage Interface.


Query a specific file's metadata, such as file names, size, and a MD5 hash of the data. This is not required before a file may be opened, saved, copied, or deleted. Once a file has been queried, its metadata will be available by the EOS_PlayerDataStorage_CopyFileMetadataAtIndex and EOS_PlayerDataStorage_CopyFileMetadataByFilename functions.

See Also

EOS_PlayerDataStorage_GetFileMetadataCount, EOS_PlayerDataStorage_CopyFileMetadataAtIndex, EOS_PlayerDataStorage_CopyFileMetadataByFilename


Parameter Type And Name

Usage Information

EOS_HPlayerDataStorage Handle

const EOS_PlayerDataStorage_QueryFileOptions* QueryFileOptions

Object containing properties related to which user is querying files, and what file is being queried

void* ClientData

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

const EOS_PlayerDataStorage_OnQueryFileCompleteCallback 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_OnQueryFileCompleteCallback to report the results of its operation.

Callback Remarks

Callback for when EOS_PlayerDataStorage_QueryFile completes

Callback Parameters

Parameter Type And Name

Usage Information

const EOS_PlayerDataStorage_QueryFileCallbackInfo* Data

Related API Members