EOS_PlayerDataStorage_CopyFileMetadataAtIndex

EOS API reference page for EOS_PlayerDataStorage_CopyFileMetadataAtIndex

Choose your implementation method:

C

C#

This function is part of the PlayerDataStorage Interface.

Remarks

Get the cached copy of a file's metadata by index. The metadata will be for the last retrieved or successfully saved version, and will not include any local changes that have not been committed by calling SaveFile. The returned pointer must be released by the user when no longer needed.

Return Value

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

See Also

EOS_PlayerDataStorage_GetFileMetadataCount, EOS_PlayerDataStorage_FileMetadata_Release

Parameters

EOS_PlayerDataStorage_CopyFileMetadataAtIndex

Parameter Type And Name

Usage Information

EOS_HPlayerDataStorage Handle

const EOS_PlayerDataStorage_CopyFileMetadataAtIndexOptions* CopyFileMetadataOptions

Object containing properties related to which user is requesting metadata, and at what index

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

Get the cached copy of a file's metadata by index. The metadata will be for the last retrieved or successfully saved version, and will not include any local changes that have not been committed by calling SaveFile. The returned pointer must be released by the user when no longer needed.

Return Value

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

See Also

{GetFileMetadataCount}, {Release}

Parameters

PlayerDataStorage.PlayerDataStorageInterface.CopyFileMetadataAtIndex

Parameter Type And Name

Usage Information

CopyFileMetadataAtIndexOptions copyFileMetadataOptions

Object containing properties related to which user is requesting metadata, and at what index

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