EOS API reference page for EOS_PlayerDataStorage_CopyFileMetadataByFilename

2 mins to read

This function is part of the PlayerDataStorage Interface.


Create the cached copy of a file's metadata by filename. The metadata will be for the last retrieved or successfully saved version, and will not include any changes that have not completed writing. The returned pointer must be released by the user when no longer needed.

Return Value

EOS_EResult::EOS_Success if the metadata is currently cached, otherwise an error result explaining what went wrong



Parameter Type And NameUsage Information
EOS_HPlayerDataStorage Handle
const EOS_PlayerDataStorage_CopyFileMetadataByFilenameOptions* CopyFileMetadataOptionsObject containing properties related to which user is requesting metadata, and for which filename
EOS_PlayerDataStorage_FileMetadata** OutMetadataA copy of the FileMetadata structure will be set if successful. This data must be released by calling EOS_PlayerDataStorage_FileMetadata_Release.

If successful, this function provides data to the caller through an output parameter. Once you are finished with the data, you must release it by making the appropriate call into the EOS SDK.