<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Class FileStat - Class FileStat</title>
<link href="faldoc.css" rel="stylesheet" type="text/css"/>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
</head>
<body class="faldoc_body">
<div class="navitop">
<div class="tabs">
<ul>
<li><a href="./index.html"><span>Main</span></a></li>
<li><a href="./pages.html"><span>Related pages</span></a></li>
<li><a href="./groups.html"><span>Groups</span></a></li>
<li><a href="./funset.html"><span>Function sets</span></a></li>
<li><a href="./classes.html"><span>Classes</span></a></li>
<li><a href="./objects.html"><span>Objects</span></a></li>
<li><a href="./functions.html"><span>All functions</span></a></li>
<li><a href="./globals.html"><span>Globals</span></a></li>
</ul>
</div>
</div>
<hr/>
<h1 class="faldoc_title">Class FileStat</h1>
<p class="faldoc_brief">Class holding informations on system files. </p>
<p class="faldoc_funcdecl">
<b>class</b> FileStat( [path] )
</p>
<p class="faldoc_brief"><a href="#more">more...</a></p>
<h2 class="faldoc_title">Summary</h2>
<table class="faldoc_list">
<tr><td><a href="#access">access</a></td><td>POSIX access mode</td></tr>
<tr><td><a href="#atime">atime</a></td><td>Last access time, expressed as a instance.</td></tr>
<tr><td><a href="#attribs">attribs</a></td><td>DOS Attributes</td></tr>
<tr><td><a href="#ctime">ctime</a></td><td>Creation time or last attribute change time, expressed as a instance.</td></tr>
<tr><td><a href="#ftype">ftype</a></td><td>File type; can be one of the following constants (declared in this class):</td></tr>
<tr><td><a href="#group">group</a></td><td>Group ID of the given file.</td></tr>
<tr><td><a href="#mtime">mtime</a></td><td>Last modify time, expressed as a instance.</td></tr>
<tr><td><a href="#owner">owner</a></td><td>Owner ID of the given file.</td></tr>
<tr><td><a href="#size">size</a></td><td>File size.</td></tr>
<tr><td><a href="#read">read()</a></td><td>Fills the data in this instance reading them from a system file. </td></tr>
</table>
<a name="more"><h2 class="faldoc_title">Detailed description</h2></a>
<p class="faldoc_funcdecl">
<b>class</b> FileStat( [path] )
</p>
<table class="faldoc_function">
<tr><td class="faldoc_optparam">path</td><td class="faldoc_optparamdesc">If given, the filestats will be initialized with stats of the given file. </td></tr>
</table>
<br/>
<p class="item_brief">Class holding informations on system files. </p>
<p class="faldoc_text">The FileStat class holds informations on a single directory entry. </p>
<p class="faldoc_text"> It is possible to pass a <b>path</b> parameter, in which case, if the given file is found, the contents of this class is filled with the stat data from the required file, otherwise an IoError is raised. The <a href="./class_FileStat.html#read">FileStat.read</a> method would search for the required file without raising in case it is not found, so if it preferable not to raise on failure (i.e. because searching the most fitting of a list of possibly existing files), it is possiblo to create the FileStat object without parameters and the use the <b>read</b> method iteratively. </p>
<ul>
<li>NORMAL </li><li>DIR </li><li>PIPE </li><li>LINK </li><li>DEVICE </li><li>SOCKET </li><li>UNKNOWN </li>
</ul>
<p class="faldoc_text">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. </p>
<p class="faldoc_text"> Times are returned as a <a href="./class_TimeStamp.html">TimeStamp</a> class instance; the time is always expressed as local system time. </p>
<h2 class="faldoc_title">Properties</h2>
<h3 class="faldoc_funcname"><a name="access">access</a></h3>
<p class="item_brief">POSIX access mode</p>
<h3 class="faldoc_funcname"><a name="atime">atime</a></h3>
<p class="item_brief">Last access time, expressed as a instance.</p>
<h3 class="faldoc_funcname"><a name="attribs">attribs</a></h3>
<p class="item_brief">DOS Attributes</p>
<h3 class="faldoc_funcname"><a name="ctime">ctime</a></h3>
<p class="item_brief">Creation time or last attribute change time, expressed as a instance.</p>
<h3 class="faldoc_funcname"><a name="ftype">ftype</a></h3>
<p class="item_brief">File type; can be one of the following constants (declared in this class):</p>
<h3 class="faldoc_funcname"><a name="group">group</a></h3>
<p class="item_brief">Group ID of the given file.</p>
<h3 class="faldoc_funcname"><a name="mtime">mtime</a></h3>
<p class="item_brief">Last modify time, expressed as a instance.</p>
<h3 class="faldoc_funcname"><a name="owner">owner</a></h3>
<p class="item_brief">Owner ID of the given file.</p>
<h3 class="faldoc_funcname"><a name="size">size</a></h3>
<p class="item_brief">File size.</p>
<h2 class="faldoc_title">Methods</h2>
<h3 class="faldoc_funcname"><a name="read">read()</a></h3>
<p class="item_brief">Fills the data in this instance reading them from a system file. </p>
<p class="faldoc_funcdecl">FileStat.read( filename )</p>
<table class="faldoc_function">
<tr><td class="faldoc_param">filename</td><td class="faldoc_paramdesc">Relative or absolute path to a file for which stats must be read </td></tr>
<tr><td class="faldoc_funcreturn">Returns:</td><td class="faldoc_funcreturndesc">True on success, false if the file cannot be queried. </td></tr>
</table>
<p class="faldoc_text"><p class="faldoc_text">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. </p>
</p>
<hr/>
<div class="navibottom">
<center>
<a href="./index.html">Main</a> - <a href="./pages.html">Related pages</a> - <a href="./groups.html">Groups</a> - <a href="./funset.html">Function sets</a> - <a href="./classes.html">Classes</a> - <a href="./objects.html">Objects</a> - <a href="./functions.html">All functions</a> - <a href="./globals.html">Globals</a>
</center>
</div>
</div>
<div class="faldoc_signature">Made with <a href="http://www.falconpl.org">faldoc 2.2.0</div>
</body>
</html>
