71 lines
11 KiB
HTML
71 lines
11 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.io.File - API Reference</title><meta name="description" content="API for reading and writing to files."/></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> File</h1><h4><small>package <a href="../../sys/io/index.html">sys.io</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>API for reading and writing to files.</p>
|
|
<p>See <code><a href="../../sys/FileSystem.html">sys.FileSystem</a></code> for the complementary file system API.</p></div></div><h3 class="section">Static methods</h3><div class="fields"><div class="field "><a name="append"></a><h3><p><code><span class="label">static</span><a href="#append"><span class="identifier">append</span></a> (<span style="white-space:nowrap">path:<a class="type" title="The basic String class." href="../../String.html">String</a>,</span> <span style="white-space:nowrap">binary:<a class="type" title="The standard Boolean type, which can either be true or false." href="../../Bool.html">Bool</a> = true</span>):<a class="type" title="Use sys." href="../../sys/io/FileOutput.html">FileOutput</a></code></p></h3><div class="doc"><p>Similar to <code><a href="../../sys/io/File.html#write">sys.io.File.write</a></code>, but appends to the file if it exists
|
|
instead of overwriting its contents.</p></div></div><div class="field "><a name="copy"></a><h3><p><code><span class="label">static</span><a href="#copy"><span class="identifier">copy</span></a> (<span style="white-space:nowrap">srcPath:<a class="type" title="The basic String class." href="../../String.html">String</a>,</span> <span style="white-space:nowrap">dstPath:<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>Copies the contents of the file specified by <code>srcPath</code> to the file
|
|
specified by <code>dstPath</code>.</p>
|
|
<p>If the <code>srcPath</code> does not exist or cannot be read, or if the <code>dstPath</code>
|
|
file cannot be written to, an exception is thrown.</p>
|
|
<p>If the file at <code>dstPath</code> exists, its contents are overwritten.</p>
|
|
<p>If <code>srcPath</code> or <code>dstPath</code> are null, the result is unspecified.</p></div></div><div class="field "><a name="getBytes"></a><h3><p><code><span class="label">static</span><a href="#getBytes"><span class="identifier">getBytes</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="" href="../../haxe/io/Bytes.html">Bytes</a></code></p></h3><div class="doc"><p>Retrieves the binary content of the file specified by <code>path</code>.</p>
|
|
<p>If the file does not exist or can not be read, an exception is thrown.</p>
|
|
<p><code><a href="../../sys/FileSystem.html#exists">sys.FileSystem.exists</a></code> can be used to check for existence.</p>
|
|
<p>If <code>path</code> is null, the result is unspecified.</p></div></div><div class="field "><a name="getContent"></a><h3><p><code><span class="label">static</span><a href="#getContent"><span class="identifier">getContent</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 basic String class." href="../../String.html">String</a></code></p></h3><div class="doc"><p>Retrieves the content of the file specified by <code>path</code> as a String.</p>
|
|
<p>If the file does not exist or can not be read, an exception is thrown.</p>
|
|
<p><code><a href="../../sys/FileSystem.html#exists">sys.FileSystem.exists</a></code> can be used to check for existence.</p>
|
|
<p>If <code>path</code> is null, the result is unspecified.</p></div></div><div class="field "><a name="read"></a><h3><p><code><span class="label">static</span><a href="#read"><span class="identifier">read</span></a> (<span style="white-space:nowrap">path:<a class="type" title="The basic String class." href="../../String.html">String</a>,</span> <span style="white-space:nowrap">binary:<a class="type" title="The standard Boolean type, which can either be true or false." href="../../Bool.html">Bool</a> = true</span>):<a class="type" title="Use sys." href="../../sys/io/FileInput.html">FileInput</a></code></p></h3><div class="doc"><p>Returns an <code><a href="../../sys/io/FileInput.html">FileInput</a></code> handle to the file specified by <code>path</code>.</p>
|
|
<p>If <code>binary</code> is true, the file is opened in binary mode. Otherwise it is
|
|
opened in non-binary mode.</p>
|
|
<p>If the file does not exist or can not be read, an exception is thrown.</p>
|
|
<p>Operations on the returned <code><a href="../../sys/io/FileInput.html">FileInput</a></code> handle read on the opened file.</p>
|
|
<p>File handles should be closed via <code><a href="../../sys/io/FileInput.html#close">FileInput.close</a></code> once the operation
|
|
is complete.</p>
|
|
<p>If <code>path</code> is null, the result is unspecified.</p></div></div><div class="field "><a name="saveBytes"></a><h3><p><code><span class="label">static</span><a href="#saveBytes"><span class="identifier">saveBytes</span></a> (<span style="white-space:nowrap">path:<a class="type" title="The basic String class." href="../../String.html">String</a>,</span> <span style="white-space:nowrap">bytes:<a class="type" title="" href="../../haxe/io/Bytes.html">Bytes</a></span>):<a class="type" title="The standard Void type." href="../../Void.html">Void</a></code></p></h3><div class="doc"><p>Stores <code>bytes</code> in the file specified by <code>path</code> in binary mode.</p>
|
|
<p>If the file cannot be written to, an exception is thrown.</p>
|
|
<p>If <code>path</code> or <code>bytes</code> are null, the result is unspecified.</p></div></div><div class="field "><a name="saveContent"></a><h3><p><code><span class="label">static</span><a href="#saveContent"><span class="identifier">saveContent</span></a> (<span style="white-space:nowrap">path:<a class="type" title="The basic String class." href="../../String.html">String</a>,</span> <span style="white-space:nowrap">content:<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>Stores <code>content</code> in the file specified by <code>path</code>.</p>
|
|
<p>If the file cannot be written to, an exception is thrown.</p>
|
|
<p>If <code>path</code> or <code>content</code> are null, the result is unspecified.</p></div></div><div class="field "><a name="write"></a><h3><p><code><span class="label">static</span><a href="#write"><span class="identifier">write</span></a> (<span style="white-space:nowrap">path:<a class="type" title="The basic String class." href="../../String.html">String</a>,</span> <span style="white-space:nowrap">binary:<a class="type" title="The standard Boolean type, which can either be true or false." href="../../Bool.html">Bool</a> = true</span>):<a class="type" title="Use sys." href="../../sys/io/FileOutput.html">FileOutput</a></code></p></h3><div class="doc"><p>Returns an <code><a href="../../sys/io/FileOutput.html">FileOutput</a></code> handle to the file specified by <code>path</code>.</p>
|
|
<p>If <code>binary</code> is true, the file is opened in binary mode. Otherwise it is
|
|
opened in non-binary mode.</p>
|
|
<p>If the file cannot be written to, an exception is thrown.</p>
|
|
<p>Operations on the returned <code><a href="../../sys/io/FileOutput.html">FileOutput</a></code> handle write to the opened file.
|
|
If the file existed, its previous content is overwritten.</p>
|
|
<p>File handles should be closed via <code><a href="../../sys/io/FileOutput.html#close">FileOutput.close</a></code> once the operation
|
|
is complete.</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> |