Class EOS_TitleStorage_ReadFileOptions
java.lang.Object
com.sun.jna.Structure
host.anzo.eossdk.eos.sdk.titlestorage.options.EOS_TitleStorage_ReadFileOptions
- Direct Known Subclasses:
EOS_TitleStorage_ReadFileOptions.ByReference
,EOS_TitleStorage_ReadFileOptions.ByValue
@FieldOrder({"ApiVersion","LocalUserId","Filename","ReadChunkLengthBytes","ReadFileDataCallback","FileTransferProgressCallback"})
public class EOS_TitleStorage_ReadFileOptions
extends com.sun.jna.Structure
Input data for the EOS_TitleStorage_ReadFile function
- Since:
- 9/3/2023
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
static class
Nested classes/interfaces inherited from class com.sun.jna.Structure
com.sun.jna.Structure.FieldOrder, com.sun.jna.Structure.StructField
-
Field Summary
FieldsModifier and TypeFieldDescriptionint
API Version: Set this toEOS_TITLESTORAGE_READFILE_API_LATEST
.static final int
The most recent version of the EOS_TitleStorage_ReadFile API.The file name to read; this file must already existOptional callback function to be informed of download progress, if the file is not already locally cached.Product User ID of the local user who is reading the requested file (optional)int
The maximum amount of data in bytes should be available to read in a single EOS_TitleStorage_OnReadFileDataCallback callCallback function to handle copying read dataFields inherited from class com.sun.jna.Structure
ALIGN_DEFAULT, ALIGN_GNUC, ALIGN_MSVC, ALIGN_NONE, CALCULATE_SIZE
-
Constructor Summary
Constructors -
Method Summary
Methods inherited from class com.sun.jna.Structure
allocateMemory, allocateMemory, autoAllocate, autoRead, autoRead, autoWrite, autoWrite, cacheTypeInfo, calculateSize, clear, createFieldsOrder, createFieldsOrder, createFieldsOrder, createFieldsOrder, dataEquals, dataEquals, ensureAllocated, equals, fieldOffset, getAutoRead, getAutoWrite, getFieldList, getFieldOrder, getFields, getNativeAlignment, getNativeSize, getNativeSize, getPointer, getStringEncoding, getStructAlignment, hashCode, newInstance, newInstance, read, readField, readField, setAlignType, setAutoRead, setAutoSynch, setAutoWrite, setStringEncoding, size, sortFields, toArray, toArray, toString, toString, useMemory, useMemory, write, writeField, writeField, writeField
-
Field Details
-
EOS_TITLESTORAGE_READFILE_API_LATEST
public static final int EOS_TITLESTORAGE_READFILE_API_LATESTThe most recent version of the EOS_TitleStorage_ReadFile API.- See Also:
-
ApiVersion
public int ApiVersionAPI Version: Set this toEOS_TITLESTORAGE_READFILE_API_LATEST
. -
LocalUserId
Product User ID of the local user who is reading the requested file (optional) -
Filename
The file name to read; this file must already exist -
ReadChunkLengthBytes
public int ReadChunkLengthBytesThe maximum amount of data in bytes should be available to read in a single EOS_TitleStorage_OnReadFileDataCallback call -
ReadFileDataCallback
Callback function to handle copying read data -
FileTransferProgressCallback
Optional 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
-
-
Constructor Details
-
EOS_TitleStorage_ReadFileOptions
public EOS_TitleStorage_ReadFileOptions() -
EOS_TitleStorage_ReadFileOptions
public EOS_TitleStorage_ReadFileOptions(com.sun.jna.Pointer peer)
-