EOS_PlayerDataStorage_CopyFileMetadataByFilename

EOS API reference page for EOS_PlayerDataStorage_CopyFileMetadataByFilename

Choose your implementation method:

C

C#

This function is part of the PlayerDataStorage Interface.

Remarks

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

Parameters

EOS_PlayerDataStorage_CopyFileMetadataByFilename

Parameter Type And Name

Usage Information

EOS_HPlayerDataStorage Handle

const EOS_PlayerDataStorage_CopyFileMetadataByFilenameOptions* CopyFileMetadataOptions

Object containing properties related to which user is requesting metadata, and for which filename

EOS_PlayerDataStorage_FileMetadata** OutMetadata

A 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.

Related API Members

This function is part of the PlayerDataStorage Interface.

Remarks

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

{Result}::{Result.Success} if the metadata is currently cached, otherwise an error result explaining what went wrong

Parameters

PlayerDataStorage.PlayerDataStorageInterface.CopyFileMetadataByFilename

Parameter Type And Name

Usage Information

CopyFileMetadataByFilenameOptions copyFileMetadataOptions

Object containing properties related to which user is requesting metadata, and for which filename

FileMetadata outMetadata

A 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. The EOS SDK will automatically handle releasing the data when your code no longer holds any reference to it; you do not need to call a "Release" function.

Related API Members