Index  |  Related pages  |  Classes  |  Functions  |  Entities  |  Function Sets  |  Groups

ClassFileStat

class FileStat

Class holding informations on system files. more...


Member list

Properties
access POSIX access mode
atime Last access time, expressed as a TimeStamp instance.
attribs DOS Attributes
ctime Creation time or last attribute change time, expressed as a TimeStamp instance.
ftype File type; can be one of the following constants (declared in this class):
group Group ID of the given file.
mtime Last modify time, expressed as a TimeStamp instance.
owner Owner ID of the given file.
size File size.
Methods
readStats Fills the data in this instance reading them from a system file.

Detailed description

The FileStat class holds informations on a single directory entry. It is returned by the FileReadStats factory function, but it can be also instantiated directly. Then the FileStat.readStats method can be used to fill the contents of the instance with actual data from the file system. Both access and attribs properties are given a value respectively only on POSIX or MS-Windows systems; their value is the underlying numeric value the system provides. The ctime property has a different meaning in MS-Windows and POSIX system. In the former, is the time at which the file has been created; in the latter is the time when the file ownership flags have been last changed, which may or may not be the same as file creation time.

Times are returned as a TimeStamp class instance; the time is always expressed as local system time.


Class properties

access
POSIX access mode

atime
Last access time, expressed as a TimeStamp instance.

attribs
DOS Attributes

ctime
Creation time or last attribute change time, expressed as a TimeStamp instance.

ftype
File type; can be one of the following constants (declared in this class):

  • NORMAL
  • DIR
  • PIPE
  • LINK
  • DEVICE
  • SOCKET
  • UNKNOWN
group
Group ID of the given file.

mtime
Last modify time, expressed as a TimeStamp instance.

owner
Owner ID of the given file.

size
File size.


Class methods

readStats()

Fills the data in this instance reading them from a system file.

FileStat.readStats( filename )
filename

Relative or absolute path to a file for which stats must be read

Returns:

True on success, false if the file cannot be queried.

Fills the contents of this object with informations on the given file. If the stats of the required file can be read, the function returns true.


Index  |  Related pages  |  Classes  |  Functions  |  Entities  |  Function Sets  |  Groups
Made with Faldoc 1.0.0