File

Method 

Description 

BytesAvailable 

Returns the number of bytes available to read from a stream without blocking. For a file, this should generally be number of bytes till the end. 

ChangeSize 

Resizes the size of the file. 

CopyFromStream 

Appends another file data from a stream. 

Close 

Closes the file. After close, file cannot be accessed. 

File 

File constructor. 

Flush 

Causes any implementation's buffered data to be delivered to destination. 

GetErrorCode 

Return errno-based error code. Useful if any other function failed. 

GetFilePath 

Returns a file name path relative to the 'reference' directory. This is often a path that was used to create a file (this is not a global path, global path can be obtained with help of directory). 

GetLength 

Returns the size of the file. 

IsEOF 

Determines whether the end of file is reached or not. 

IsValid 

Determines whether file is usable (open). 

IsWritable 

Determines whether file is writeable. 

LGetLength 

Overridden method. Returns the length of the file. 

LTell 

Overridden method, returns the current position in the file. 

Read 

Blocking read, will read in the given number of bytes or less from the stream. 

ReadDouble 

Reading primitive types - Little Endian. 

ReadUInt16 

Reading primitive types - Little Endian. 

ReadUInt16BE 

Reading primitive types - Big Endian. 

ReadDoubleBE 

Reading primitive types - Big Endian. 

ReadFloat 

Reading primitive types - Little Endian. 

ReadFloatBE 

Reading primitive types - Big Endian. 

ReadSByte 

Reading primitive types - Little Endian. 

ReadSByteBE 

Reading primitive types - Big Endian. 

ReadSInt16 

Reading primitive types - Little Endian. 

ReadSInt16BE 

Reading primitive types - Big Endian. 

ReadSInt32 

Reading primitive types - Little Endian. 

ReadSInt32BE 

Reading primitive types - Big Endian. 

ReadSInt64 

Reading primitive types - Little Endian. 

ReadSInt64BE 

Reading primitive types - Big Endian. 

ReadSInt8 

Reading primitive types - Little Endian. 

ReadSInt8BE 

Reading primitive types - Big Endian. 

ReadUByte 

Reading primitive types - Little Endian. 

ReadUByteBE 

Reading primitive types - Big Endian. 

ReadUInt32 

Reading primitive types - Little Endian. 

ReadUInt32BE 

Reading primitive types - Big Endian. 

ReadUInt64 

Reading primitive types - Little Endian. 

ReadUInt64BE 

Reading primitive types - Big Endian. 

ReadUInt8 

Reading primitive types - Little Endian. 

ReadUInt8BE 

Reading primitive types - Big Endian. 

SeekToBegin 

Seek the position from the beginning of the file. 

SeekToEnd 

Seek the position from the beginning to the end of the file. 

LSeek 

Overrridden method. Sets file position indicator. 

Skip 

Seek simplification. 

SkipBytes 

Skips (ignores) a given number of bytes. 

Seek 

Sets file position indicator. 

Tell 

Returns the current position in the file. 

Write 

Write in the given number of bytes or less to the stream. 

WriteSByte 

Writing primitive types - Little Endian. 

WriteSByteBE 

Writing primitive types - Big Endian. 

WriteSInt16 

Writing primitive types - Little Endian. 

WriteSInt16BE 

Writing primitive types - Big Endian. 

WriteSInt32 

Writing primitive types - Little Endian. 

WriteSInt32BE 

Writing primitive types - Big Endian. 

WriteSInt64 

Writing primitive types - Little Endian. 

WriteSInt64BE 

Writing primitive types - Big Endian. 

WriteSInt8 

Writing primitive types - Little Endian. 

WriteSInt8BE 

Writing primitive types - Big Endian. 

WriteUByte 

Writing primitive types - Little Endian. 

WriteUByteBE 

Writing primitive types - Big Endian. 

WriteDouble 

 

WriteUInt16 

Writing primitive types - Little Endian. 

WriteDoubleBE 

 

WriteUInt16BE 

Writing primitive types - Big Endian. 

WriteUInt32 

Writing primitive types - Little Endian. 

WriteUInt32BE 

Writing primitive types - Big Endian. 

WriteUInt64 

Writing primitive types - Little Endian. 

WriteUInt64BE 

Writing primitive types - Big Endian. 

WriteUInt8 

Writing primitive types - Little Endian. 

WriteUInt8BE 

Writing primitive types - Big Endian. 

WriteFloat 

Writing primitive types - Little Endian. 

WriteFloatBE 

Writing primitive types - Big Endian. 

Topic 

Description 

Scaleform::File::WriteDouble@Double 

Writing primitive types - Little Endian. 

Scaleform::File::WriteDoubleBE@Double 

Writing primitive types - Big Endian.