Moai SDK  2.0
MOAIFileStream Class Reference
+ Inheritance diagram for MOAIFileStream:

Function List

close
 
open
 
- Function List inherited from MOAIStream
collapse
 
compact
 
flush
 
getCursor
 
getLength
 
read
 
read8
 
read16
 
read32
 
readBoolean
 
readDouble
 
readFloat
 
readFormat
 
readU8
 
readU16
 
readU32
 
seek
 
write
 
write8
 
write16
 
write32
 
writeBoolean
 
writeColor32
 
writeDouble
 
writeFloat
 
writeFormat
 
writeStream
 
writeU8
 
writeU16
 
writeU32
 

Detailed Description

Constants
MOAIFileStream.READ
MOAIFileStream.READ_WRITE
MOAIFileStream.READ_WRITE_AFFIRM
MOAIFileStream.READ_WRITE_NEW
MOAIFileStream.WRITE

Function Documentation

close

Close and release the associated file handle.


function close ( MOAIFileStream self )

Parameters
MOAIFileStreamself
Returns
nil
open

Open or create a file stream given a valid path.


function open ( MOAIFileStream self, string fileName [, number mode ] )

Parameters
MOAIFileStreamself
stringfileName
numbermode Optional. One of MOAIFileStream.APPEND, MOAIFileStream.READ, MOAIFileStream.READ_WRITE, MOAIFileStream.READ_WRITE_AFFIRM, MOAIFileStream.READ_WRITE_NEW, MOAIFileStream.WRITE. Default value is MOAIFileStream.READ.
Returns
boolean success