Torque3D Documentation / _generateds / FileStreamObject

FileStreamObject

Engine/source/core/stream/fileStreamObject.h

More...

Private Types

Parent 

Protected Attributes

Public Functions

Close the file.

bool

Called when the object is added to the sim.

bool
open(const char * filename, Torque::FS::File::AccessMode mode)

Open a file.

Detailed Description

Private Types

typedef StreamObject Parent 

Protected Attributes

FileStream mFileStream 

Public Functions

FileStreamObject()

~FileStreamObject()

close()

Close the file.

see:

DECLARE_CONOBJECT(FileStreamObject )

onAdd()

Reimplemented from: StreamObject

open(const char * filename, Torque::FS::File::AccessMode mode)

Open a file.

Parameters:

filename

Name of file to open

mode

One of Torque::FS::File::Read, Torque::FS::File::Write, Torque::FS::File::ReadWrite or Torque::FS::File::WriteAppend

return:

true for success, false for failure