EOS API reference page for EOS_PlayerDataStorage_QueryFile

3 mins to read

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.

Return Value

  • EOS_Success if the query completes successfully and a file is found

  • EOS_NotFound if no file is found

See Also

EOS_PlayerDataStorage_GetFileMetadataCount, EOS_PlayerDataStorage_CopyFileMetadataAtIndex, EOS_PlayerDataStorage_CopyFileMetadataByFilename



Parameter Type And NameUsage Information
EOS_HPlayerDataStorage Handle
const EOS_PlayerDataStorage_QueryFileOptions* QueryFileOptionsObject containing properties related to which user is querying files, and what file is being queried
void* ClientDataOptional pointer to help clients track this request, that is returned in the completion callback
const EOS_PlayerDataStorage_OnQueryFileCompleteCallback CompletionCallbackThis function is called when the query operation completes

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 NameUsage Information
const EOS_PlayerDataStorage_QueryFileCallbackInfo* Data