Torque3D Documentation / _generateds / Torque::FS::File

Torque::FS::File

Engine/source/core/volume.h

File object in a FileSystem.

More...

Public Types

enum
AccessMode {
  Read = 0
  Write = 1
  ReadWrite = 2
  WriteAppend = 3
}
enum
SeekMode {
  Begin 
  Current 
  End 
}

Public Functions

File()

~File()

bool

close()

U32

getPosition()

bool

open(AccessMode mode)

U32

read(void * dst, U32 size)

U32

setPosition(U32 pos, SeekMode mode)

U32

write(const void * src, U32 size)

Detailed Description
File object in a FileSystem.
File object in a FileSystem. When a file is initially obtained from a FileSystem it is in a closed state.
Public Types
AccessMode

Enumerator
Read = 0
Open for read only.
Write = 1
Open for write only.
ReadWrite = 2
Open for read-write.
WriteAppend = 3
Write-only, starting at end of file.
SeekMode

Enumerator
Begin 
Relative to the start of the file.
Current 
Relative to the current position.
End 
Relative to the end of the file.
Public Functions
File()

~File()

close()

Reimplemented by: Torque::Mem::MemFile, Torque::ZipFileNode, Torque::Posix::PosixFile, Torque::Win32::Win32File
getPosition()

Reimplemented by: Torque::Mem::MemFile, Torque::ZipFileNode, Torque::Posix::PosixFile, Torque::Win32::Win32File
open(AccessMode mode)

Reimplemented by: Torque::ZipFileNode, Torque::Mem::MemFile, Torque::Posix::PosixFile, Torque::Win32::Win32File
read(void * dst, U32 size)

Reimplemented by: Torque::Mem::MemFile, Torque::ZipFileNode, Torque::Posix::PosixFile, Torque::Win32::Win32File
setPosition(U32 pos, SeekMode mode)

Reimplemented by: Torque::ZipFileNode, Torque::Mem::MemFile, Torque::Posix::PosixFile, Torque::Win32::Win32File
write(const void * src, U32 size)

Reimplemented by: Torque::Mem::MemFile, Torque::ZipFileNode, Torque::Posix::PosixFile, Torque::Win32::Win32File