Objeck Documentation

All Bundles

File

Provides file operations

Operations

New
AccessedTime
Copy
CreateTime
Delete
Exists
Flush
GetFullName
GetName
GetTempName
Group
IsEoF
IsOpen
IsReadOnly
IsReadWrite
IsWriteOnly
ModifiedTime
Owner
Rename
Rewind
Seek
Size

AccessedTime

Returns the time in which the file was accessed

function : AccessedTime(n:System.String) ~ Date

Parameters

Name	Type	Description
n	String	filename

Return

Type	Description
Date	accessed date

AccessedTime

Returns the time in which the file was accessed

method : public : AccessedTime() ~ Date

Return

Type	Description
Date	accessed date

AccessedTime

Returns the time in which the file was accessed

function : AccessedTime(n:System.String, gmt:Bool) ~ Date

Parameters

Name	Type	Description
n	String	filename
gmt	Bool	true if GMT

Return

Type	Description
Date	accessed date

AccessedTime

Returns the time in which the file was accessed

method : public : AccessedTime(gmt:Bool) ~ Date

Parameters

Name	Type	Description
gmt	Bool	true if GMT

Return

Type	Description
Date	accessed date

Copy

Copies a file

function : Copy(s:System.String, d:System.String) ~ Bool

Parameters

Name	Type	Description
s	String	source filename
d	String	destination filename

Return

Type	Description
Bool	true if file was copied

Copy

Copies a file

function : Copy(s:System.String, d:System.String, o:Bool) ~ Bool

Parameters

Name	Type	Description
s	String	source filename
d	String	destination filename
o	Bool	true to overwrite existing file, false otherwise

Return

Type	Description
Bool	true if file was copied

CreateTime

Returns the time in which the file was created

function : CreateTime(n:System.String) ~ Date

Parameters

Name	Type	Description
n	String	filename

Return

Type	Description
Date	create date

CreateTime

Returns the time in which the file was created

method : public : CreateTime() ~ Date

Return

Type	Description
Date	create date

CreateTime

Returns the time in which the file was created

function : CreateTime(n:System.String, gmt:Bool) ~ Date

Parameters

Name	Type	Description
n	String	filename
gmt	Bool	true if GMT

Return

Type	Description
Date	create date

CreateTime

Returns the time in which the file was created

method : public : CreateTime(gmt:Bool) ~ Date

Parameters

Name	Type	Description
gmt	Bool	true if GMT

Return

Type	Description
Date	create date

Delete

Deletes the file

function : Delete(n:System.String) ~ Bool

Parameters

Name	Type	Description
n	String	filename

Return

Type	Description
Bool	true if file was deleted, false otherwise

Delete

Deletes a file

method : public : Delete() ~ Bool

Return

Type	Description
Bool	true if file was deleted

Exists

Checks if a file exists

function : Exists(n:System.String) ~ Bool

Parameters

Name	Type	Description
n	String	filename

Return

Type	Description
Bool	true if file exists

Exists

Checks if a file exists

method : public : Exists() ~ Bool

Return

Type	Description
Bool	true if file exists

Flush

Flushes the file buffer

method : public : Flush() ~ Nil

GetFullName

Gets the full path name for file

function : GetFullName(n:System.String) ~ System.String

Parameters

Name	Type	Description
n	String	filename

Return

Type	Description
String	full path name, Nil otherwise

GetFullName

Gets the full path name for file

method : public : GetFullName() ~ System.String

Return

Type	Description
String	full path name, Nil otherwise

GetName

Gets the filename

method : public : GetName() ~ String

Return

Type	Description
String	filename

GetTempName

Gets a temporary filename

function : GetTempName() ~ System.String

Return

Type	Description
String	temporary filename

Group

Gets the file group name

function : Group(n:System.String) ~ System.String

Parameters

Name	Type	Description
n	String	filename

Return

Type	Description
String	file group name

Group

Gets the file group name

method : public : Group() ~ System.String

Return

Type	Description
String	file group name

IsEoF

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

method : public : IsEoF() ~ Bool

Return

Type	Description
Bool	true if at the end-of-file, false otherwise

IsOpen

Checks of the file is open

method : public : IsOpen() ~ Bool

Return

Type	Description
Bool	true if the file was opened, false otherwise

IsReadOnly

Checks if a file can be read

function : IsReadOnly(n:System.String) ~ Bool

Parameters

Name	Type	Description
n	String	filename

Return

Type	Description
Bool	true if file can be read

IsReadOnly

Checks if a file can be read

method : public : IsReadOnly() ~ Bool

Return

Type	Description
Bool	true if file can be read

IsReadWrite

Checks if a file can be read-only

function : IsReadWrite(n:System.String) ~ Bool

Parameters

Name	Type	Description
n	String	filename

Return

Type	Description
Bool	true if file can be read-only

IsReadWrite

Checks if a file can be read-only

method : public : IsReadWrite() ~ Bool

Return

Type	Description
Bool	true if file can be read-only

IsWriteOnly

Checks if a file can be written

function : IsWriteOnly(n:System.String) ~ Bool

Parameters

Name	Type	Description
n	String	filename

Return

Type	Description
Bool	true if file can be written

IsWriteOnly

Checks if a file can be written

method : public : IsWriteOnly() ~ Bool

Return

Type	Description
Bool	true if file can be written

ModifiedTime

Returns the time in which the file was modified

function : ModifiedTime(n:System.String) ~ Date

Parameters

Name	Type	Description
n	String	filename

Return

Type	Description
Date	modified date

ModifiedTime

Returns the time in which the file was modified

function : ModifiedTime(n:System.String, gmt:Bool) ~ Date

Parameters

Name	Type	Description
n	String	filename
gmt	Bool	true if GMT

Return

Type	Description
Date	modified date

New

Default constructor

New(name:System.String)

Parameters

Name	Type	Description
name	String	filename

Owner

Gets the file owner name

function : Owner(n:System.String) ~ System.String

Parameters

Name	Type	Description
n	String	filename

Return

Type	Description
String	file owner name

Owner

Gets the file owner name

method : public : Owner() ~ System.String

Return

Type	Description
String	file owner name

Rename

Renames a file

function : Rename(o:System.String, n:System.String) ~ Bool

Parameters

Name	Type	Description
o	String	original filename
n	String	new filename

Return

Type	Description
Bool	true 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

Name	Type	Description
p	Int	seek offset

Return

Type	Description
Bool	true if operation was successful, false otherwise

Size

Returns the size of the file

function : Size(n:System.String) ~ Int

Parameters

Name	Type	Description
n	String	filename

Return

Type	Description
Int	size of the file

Size

Returns the size of the file

method : public : Size() ~ Int

Return

Type	Description
Int	size of the file