EOS_TitleStorage_ReadFileOptions

EOS API reference page for EOS_TitleStorage_ReadFileOptions

Less than a minute

This data structure is part of the TitleStorage Interface.

Remarks

Input data for the EOS_TitleStorage_ReadFile function

Properties

EOS_TitleStorage_ReadFileOptions

PropertyValue
int32_t ApiVersionAPI Version: Set this to EOS_TITLESTORAGE_READFILEOPTIONS_API_LATEST.
EOS_ProductUserId LocalUserIdProduct User ID of the local user who is reading the requested file (optional)
const char* FilenameThe file name to read; this file must already exist
uint32_t ReadChunkLengthBytesThe maximum amount of data in bytes should be available to read in a single EOS_TitleStorage_OnReadFileDataCallback call
EOS_TitleStorage_OnReadFileDataCallback ReadFileDataCallbackCallback function to handle copying read data
EOS_TitleStorage_OnFileTransferProgressCallback FileTransferProgressCallbackOptional callback function to be informed of download progress, if the file is not already locally cached. If set, this will be called at least once before completion if the request is successfully started