EOS API reference page for EOS_TitleStorage_CopyFileMetadataAtIndex

2 mins to read

This function is part of the TitleStorage Interface.


Get the cached copy of a file's metadata by index. The metadata will be for the last retrieved version. The returned pointer must be released by the user when no longer needed.

Return Value

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

See Also

EOS_TitleStorage_GetFileMetadataCount, EOS_TitleStorage_FileMetadata_Release



Parameter Type And NameUsage Information
EOS_HTitleStorage Handle
const EOS_TitleStorage_CopyFileMetadataAtIndexOptions* OptionsObject containing properties related to which user is requesting metadata, and at what index
EOS_TitleStorage_FileMetadata** OutMetadataA copy of the FileMetadata structure will be set if successful. This data must be released by calling EOS_TitleStorage_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.