EOS_PlayerDataStorage_ReadFileOptions

EOS API reference page for EOS_PlayerDataStorage_ReadFileOptions

This data structure is part of the PlayerDataStorage Interface.

Remarks

Input data for the EOS_PlayerDataStorage_ReadFile function

Properties

EOS_PlayerDataStorage_ReadFileOptions

Property

Value

int32_t ApiVersion

API Version: Set this to EOS_PLAYERDATASTORAGE_READFILEOPTIONS_API_LATEST.

EOS_ProductUserId LocalUserId

The Product User ID of the local user who is reading the requested file

const char* Filename

The file name to read; this file must already exist

uint32_t ReadChunkLengthBytes

The maximum amount of data in bytes should be available to read in a single EOS_PlayerDataStorage_OnReadFileDataCallback call

EOS_PlayerDataStorage_OnReadFileDataCallback ReadFileDataCallback

Callback function that handles data as it comes in, and can stop the transfer early

EOS_PlayerDataStorage_OnFileTransferProgressCallback FileTransferProgressCallback

Optional callback function to be informed of download progress, if the file is not already locally cached; if provided, this will be called at least once before completion if the request is successfully started

Related API Members