EOS API reference page for EOS_TitleStorage_QueryFile

3 mins to read

This function is part of the TitleStorage 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. Once a file has been queried, its metadata will be available by the EOS_TitleStorage_CopyFileMetadataAtIndex and EOS_TitleStorage_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_TitleStorage_GetFileMetadataCount, EOS_TitleStorage_CopyFileMetadataAtIndex, EOS_TitleStorage_CopyFileMetadataByFilename



Parameter Type And NameUsage Information
EOS_HTitleStorage Handle
const EOS_TitleStorage_QueryFileOptions* OptionsObject 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_TitleStorage_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_TitleStorage_OnQueryFileCompleteCallback to report the results of its operation.

Callback Remarks

Callback for when EOS_TitleStorage_QueryFile completes

Callback Parameters


Parameter Type And NameUsage Information
const EOS_TitleStorage_QueryFileCallbackInfo* Data