Home

File

Provides file operations

Operations

New

Default constructor

New(name:String)
Parameters
NameTypeDescription
nameStringfile name

AccessedTime

Returns the time in which the file was accessed

function : public : AccessedTime(n:String) ~ Date
Parameters
NameTypeDescription
nStringfile name

Return
TypeDescription
Dateaccessed date

Returns the time in which the file was accessed

function : public : AccessedTime(n:String, gmt:Bool) ~ Date
Parameters
NameTypeDescription
nStringfile name
gmtBooltrue if GMT

Return
TypeDescription
Dateaccessed date

CreateTime

Returns the time in which the file was created

function : public : CreateTime(n:String) ~ Date
Parameters
NameTypeDescription
nStringfile name

Return
TypeDescription
Datecreate date

Returns the time in which the file was created

function : public : CreateTime(n:String, gmt:Bool) ~ Date
Parameters
NameTypeDescription
nStringfile name
gmtBooltrue if GMT

Return
TypeDescription
Datecreate date

Delete

Deletes a file

function : public : Delete(n:String) ~ Bool
Parameters
NameTypeDescription
nStringfile name

Return
TypeDescription
Booltrue if file was deleted

Exists

Check to see if a file exists

function : public : Exists(n:String) ~ Bool
Parameters
NameTypeDescription
nStringfile name

Return
TypeDescription
Booltrue if file exists

Group

Gets the file group name

function : public : Group(n:String) ~ String
Parameters
NameTypeDescription
nStringfile name

Return
TypeDescription
Stringfile group name

IsEOF

Check if seek pointer is at the end-of-file

method : public : IsEOF() ~ Bool
Return
TypeDescription
Booltrue if at the end-of-file, false otherwise

IsOpen

Checks of the file is open

method : public : IsOpen() ~ Bool
Return
TypeDescription
Booltrue if the file was opened, false otherwise

IsReadOnly

Check to see if a file can be read

function : public : IsReadOnly(n:String) ~ Bool
Parameters
NameTypeDescription
nStringfile name

Return
TypeDescription
Booltrue if file can be read

IsReadWrite

Check to see if a file can be read-only

function : public : IsReadWrite(n:String) ~ Bool
Parameters
NameTypeDescription
nStringfile name

Return
TypeDescription
Booltrue if file can be read-only

IsWriteOnly

Check to see if a file can be written

function : public : IsWriteOnly(n:String) ~ Bool
Parameters
NameTypeDescription
nStringfile name

Return
TypeDescription
Booltrue if file can be written

ModifiedTime

Returns the time in which the file was modified

function : public : ModifiedTime(n:String) ~ Date
Parameters
NameTypeDescription
nStringfile name

Return
TypeDescription
Datemodified date

Returns the time in which the file was modified

function : public : ModifiedTime(n:String, gmt:Bool) ~ Date
Parameters
NameTypeDescription
nStringfile name
gmtBooltrue if GMT

Return
TypeDescription
Datemodified date

Owner

Gets the file owner name

function : public : Owner(n:String) ~ String
Parameters
NameTypeDescription
nStringfile name

Return
TypeDescription
Stringfile owner name

Rename

Renames a file

function : public : Rename(o:String, n:String) ~ Bool
Parameters
NameTypeDescription
oStringoriginal file name
nStringnew file name

Return
TypeDescription
Booltrue if file was renamed

Rewind

Rewinds the seek pointer

method : public : Rewind() ~ Nil

Seek

Seeks to a point in the file

method : public : Seek(p:Int) ~ Bool
Parameters
NameTypeDescription
pIntseek offset

Return
TypeDescription
Booltrue if operation was successful, false otherwise

Size

Returns the size of the file

function : public : Size(n:String) ~ Int
Parameters
NameTypeDescription
nStringfile name

Return
TypeDescription
Intsize of the file