64 lines
10 KiB
HTML
64 lines
10 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en"><!-- use theme color or fallback -->
|
|
<!--use textcolor from settings, otherwise create a contrasting color to theme color-->
|
|
<head><meta charset="utf-8"/><link href="../bootstrap/css/bootstrap.min.css" rel="stylesheet"/><link href="../bootstrap/css/bootstrap-responsive.min.css" rel="stylesheet"/><link href="../bootstrap/css/bootstrap-select.min.css" rel="stylesheet"/><link href="http://fonts.googleapis.com/css?family=Open+Sans:400,700,700italic,400italic" rel="stylesheet" type="text/css"/><link href="http://fonts.googleapis.com/css?family=Source+Sans+Pro:200,600,600italic,400" rel="stylesheet" type="text/css"/><link href="http://netdna.bootstrapcdn.com/font-awesome/4.1.0/css/font-awesome.css" rel="stylesheet" type="text/css"/><script src="../jquery-1.9.1.min.js"></script><script src="../bootstrap/js/bootstrap.min.js"></script><script src="../bootstrap/js/bootstrap-select.min.js"></script><link href="../styles.css" rel="stylesheet"/><link href="../haxe-nav.css" rel="stylesheet"/><script type="text/javascript">var dox = {rootPath: "../",platforms: ["Neko","Android","Flash","iOS","macOS","Linux","HTML5","Windows"]};</script><script type="text/javascript" src="../nav.js"></script><script type="text/javascript" src="../index.js"></script><link rel="icon" href="../favicon.ico" type="image/x-icon"></link><title>sys.FileSystem - API Reference</title><meta name="description" content="This class allows you to get information about the files and directories."/></head><body><style>
|
|
a, code .type {
|
|
color: #24afc4;
|
|
}
|
|
.navbar .brand {
|
|
display: inline-block;
|
|
float: none;
|
|
text-shadow: 0 0 0 transparent;
|
|
}
|
|
.nav-list>.active>a.treeLink, .nav-list>.active>a.treeLink:hover, .nav-list>.active>a.treeLink:focus {
|
|
background: #24afc4;
|
|
color: #ffffff;
|
|
text-shadow: 0 0 0 transparent;
|
|
}
|
|
.navbar .container {
|
|
width: 940px ;
|
|
}
|
|
@media (max-width: 767px) {
|
|
.navbar .container {
|
|
width: auto;
|
|
}
|
|
}
|
|
@media (max-width: 979px) and (min-width: 768px) {
|
|
.navbar .container {
|
|
width: 724px;
|
|
}
|
|
}
|
|
@media (min-width: 1200px) {
|
|
.navbar .container {
|
|
width: 1170px;
|
|
}
|
|
}
|
|
.navbar .container img {
|
|
margin: 5px 0 0 4px;
|
|
}
|
|
</style><nav class="nav"><div class="navbar"><div class="navbar-inner" style="background:#FAFAFA; border-bottom:1px solid rgba(0,0,0,.09)"><div class="container"><a class="brand" href="http://www.openfl.org"><img alt="" src="http://www.openfl.org/images/logo.png"/></a><a class="brand" style="color:#777777" href="../">API Reference</a></div></div></div></nav><div class="container main-content"><div class="row-fluid"><div class="span3"><div class="well sidebar-nav"><form class="form-search" id="searchForm"><div class="input-prepend input-block-level"><span class="add-on"><i class="icon-search"></i></span><input id="search" type="text" placeholder="Search" autocomplete="off"/></div></form><div class="dropdown"><select id="select-platform" class="selectpicker" title="Filter by platform" data-width="100%"><option value="all" selected="true">All Platforms</option><option>Neko</option><option>Android</option><option>Flash</option><option>iOS</option><option>macOS</option><option>Linux</option><option>HTML5</option><option>Windows</option></select></div></div><div class="well sidebar-nav"><div id="nav"></div></div></div><div class="span9"><div class="page-header"><h1><small>class</small> FileSystem</h1><h4><small>package <a href="../sys/index.html">sys</a></small></h4> <p class="availability"><hr/><em>Available on Neko, macOS, Linux, Windows</em></p></div><div class="body"><div class="doc doc-main"><div class="indent"><p>This class allows you to get information about the files and directories.</p>
|
|
<p>See <code><a href="../sys/io/File.html">sys.io.File</a></code> for the complementary file API.</p></div></div><h3 class="section">Static methods</h3><div class="fields"><div class="field "><a name="absolutePath"></a><h3><p><code><span class="label">static</span><a href="#absolutePath"><span class="identifier">absolutePath</span></a> (<span style="white-space:nowrap">relPath:<a class="type" title="The basic String class." href="../String.html">String</a></span>):<a class="type" title="The basic String class." href="../String.html">String</a></code></p></h3><div class="doc"><p>Returns the full path of the file or directory specified by <code>relPath</code>,
|
|
which is relative to the current working directory. The path doesn't
|
|
have to exist.</p>
|
|
<p>If <code>relPath</code> is null, the result is unspecified.</p></div></div><div class="field "><a name="createDirectory"></a><h3><p><code><span class="label">static</span><a href="#createDirectory"><span class="identifier">createDirectory</span></a> (<span style="white-space:nowrap">path:<a class="type" title="The basic String class." href="../String.html">String</a></span>):<a class="type" title="The standard Void type." href="../Void.html">Void</a></code></p></h3><div class="doc"><p>Creates a directory specified by <code>path</code>.</p>
|
|
<p>This method is recursive: The parent directories don't have to exist.</p>
|
|
<p>If the directory cannot be created, an exception is thrown.</p>
|
|
<p>If <code>path</code> is null, the result is unspecified.</p></div></div><div class="field "><a name="deleteDirectory"></a><h3><p><code><span class="label">static</span><a href="#deleteDirectory"><span class="identifier">deleteDirectory</span></a> (<span style="white-space:nowrap">path:<a class="type" title="The basic String class." href="../String.html">String</a></span>):<a class="type" title="The standard Void type." href="../Void.html">Void</a></code></p></h3><div class="doc"><p>Deletes the directory specified by <code>path</code>.</p>
|
|
<p>If <code>path</code> does not denote a valid directory, or if that directory cannot
|
|
be deleted, an exception is thrown.</p>
|
|
<p>If <code>path</code> is null, the result is unspecified.</p></div></div><div class="field "><a name="deleteFile"></a><h3><p><code><span class="label">static</span><a href="#deleteFile"><span class="identifier">deleteFile</span></a> (<span style="white-space:nowrap">path:<a class="type" title="The basic String class." href="../String.html">String</a></span>):<a class="type" title="The standard Void type." href="../Void.html">Void</a></code></p></h3><div class="doc"><p>Deletes the file specified by <code>path</code>.</p>
|
|
<p>If <code>path</code> does not denote a valid file, or if that file cannot be
|
|
deleted, an exception is thrown.</p>
|
|
<p>If <code>path</code> is null, the result is unspecified.</p></div></div><div class="field "><a name="exists"></a><h3><p><code><span class="label">static</span><a href="#exists"><span class="identifier">exists</span></a> (<span style="white-space:nowrap">path:<a class="type" title="The basic String class." href="../String.html">String</a></span>):<a class="type" title="The standard Boolean type, which can either be true or false." href="../Bool.html">Bool</a></code></p></h3><div class="doc"><p>Tells if the file or directory specified by <code>path</code> exists.</p>
|
|
<p>If <code>path</code> is null, the result is unspecified.</p></div></div><div class="field "><a name="fullPath"></a><h3><p><code><span class="label">static</span><a href="#fullPath"><span class="identifier">fullPath</span></a> (<span style="white-space:nowrap">relPath:<a class="type" title="The basic String class." href="../String.html">String</a></span>):<a class="type" title="The basic String class." href="../String.html">String</a></code></p></h3><div class="doc"><p>Returns the full path of the file or directory specified by <code>relPath</code>,
|
|
which is relative to the current working directory. Symlinks will be
|
|
followed and the path will be normalized.</p>
|
|
<p>If <code>relPath</code> is null, the result is unspecified.</p></div></div><div class="field "><a name="isDirectory"></a><h3><p><code><span class="label">static</span><a href="#isDirectory"><span class="identifier">isDirectory</span></a> (<span style="white-space:nowrap">path:<a class="type" title="The basic String class." href="../String.html">String</a></span>):<a class="type" title="The standard Boolean type, which can either be true or false." href="../Bool.html">Bool</a></code></p></h3><p class="availability"><em>Available on macOS, Linux, Windows</em></p><div class="doc"><p>Tells if the file or directory specified by <code>path</code> is a directory.</p>
|
|
<p>If <code>path</code> is not a valid file system entry or if its destination is not
|
|
accessible, an exception is thrown.</p>
|
|
<p>If <code>path</code> is null, the result is unspecified.</p></div></div><div class="field "><a name="readDirectory"></a><h3><p><code><span class="label">static</span><a href="#readDirectory"><span class="identifier">readDirectory</span></a> (<span style="white-space:nowrap">path:<a class="type" title="The basic String class." href="../String.html">String</a></span>):<a class="type" title="An Array is a storage for values." href="../Array.html">Array</a><<a class="type" title="The basic String class." href="../String.html">String</a>></code></p></h3><div class="doc"><p>Returns the names of all files and directories in the directory specified
|
|
by <code>path</code>.</p>
|
|
<p>If <code>path</code> does not denote a valid directory, an exception is thrown.</p>
|
|
<p>If <code>path</code> is null, the result is unspecified.</p></div></div><div class="field "><a name="stat"></a><h3><p><code><span class="label">static</span><a href="#stat"><span class="identifier">stat</span></a> (<span style="white-space:nowrap">path:<a class="type" title="The basic String class." href="../String.html">String</a></span>):<a class="type" title="File information, as given by sys." href="../sys/FileStat.html">FileStat</a></code></p></h3><div class="doc"><p>Returns <code><a href="../sys/FileStat.html">FileStat</a></code> information on the file or directory specified by
|
|
<code>path</code>.</p>
|
|
<p>If <code>path</code> is null, the result is unspecified.</p></div></div></div></div></div></div></div><footer class="section site-footer" style="background:#FAFAFA"><div class="container"><div class="copyright"><p style="color:#777777">© 2017 <a style="color:#777777" href="http://www.openfl.org">http://www.openfl.org</a></p></div></div></footer><script src="..//highlighter.js"></script><link href="../highlighter.css" rel="stylesheet"/></body></html> |