TorqueEngine
/
Torque2D
-ын хуулбар https://github.com/TorqueGameEngines/Torque2D.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603
							<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Torque2D Reference: File Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Torque2D Reference
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="class_file-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">File Class Reference</div></div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;platformFileIO.h&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a67a0db04d321a74b7e7fcfd3f1a3f70b" id="r_a67a0db04d321a74b7e7fcfd3f1a3f70b"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file.html#a67a0db04d321a74b7e7fcfd3f1a3f70b">Status</a> { <br />
&#160;&#160;<a class="el" href="class_file.html#a67a0db04d321a74b7e7fcfd3f1a3f70ba06d32f047358de4e6a30c28046f4688e">Ok</a> = 0
, <a class="el" href="class_file.html#a67a0db04d321a74b7e7fcfd3f1a3f70ba53ea0cae152133005a5dbe9a1329765c">IOError</a>
, <a class="el" href="class_file.html#a67a0db04d321a74b7e7fcfd3f1a3f70bae4953b2aea10c683c1f4990a11e01d4d">EOS</a>
, <a class="el" href="class_file.html#a67a0db04d321a74b7e7fcfd3f1a3f70baa359c7ce2440768125c74d431817548a">IllegalCall</a>
, <br />
&#160;&#160;<a class="el" href="class_file.html#a67a0db04d321a74b7e7fcfd3f1a3f70ba30c0b4dad1e3a3b93f822b9cef26244b">Closed</a>
, <a class="el" href="class_file.html#a67a0db04d321a74b7e7fcfd3f1a3f70ba36b13bee92e122caddcb8abefb6eec31">UnknownError</a>
<br />
 }</td></tr>
<tr class="memdesc:a67a0db04d321a74b7e7fcfd3f1a3f70b"><td class="mdescLeft">&#160;</td><td class="mdescRight">What is the status of our file handle?  <a href="class_file.html#a67a0db04d321a74b7e7fcfd3f1a3f70b">More...</a><br /></td></tr>
<tr class="separator:a67a0db04d321a74b7e7fcfd3f1a3f70b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab22d35ed086a478dd91e93ac78037f40" id="r_ab22d35ed086a478dd91e93ac78037f40"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file.html#ab22d35ed086a478dd91e93ac78037f40">AccessMode</a> { <a class="el" href="class_file.html#ab22d35ed086a478dd91e93ac78037f40a809abe96853e69894bbf8e5730b31348">Read</a> = 0
, <a class="el" href="class_file.html#ab22d35ed086a478dd91e93ac78037f40aa56670174817e3fed92bfd8182d7c0d1">Write</a> = 1
, <a class="el" href="class_file.html#ab22d35ed086a478dd91e93ac78037f40a3c4d2d19c91b345c33a83ca9f551f4e1">ReadWrite</a> = 2
, <a class="el" href="class_file.html#ab22d35ed086a478dd91e93ac78037f40a41d36294f7608c7e5565aee5aee6dcf7">WriteAppend</a> = 3
 }</td></tr>
<tr class="memdesc:ab22d35ed086a478dd91e93ac78037f40"><td class="mdescLeft">&#160;</td><td class="mdescRight">How are we accessing the file?  <a href="class_file.html#ab22d35ed086a478dd91e93ac78037f40">More...</a><br /></td></tr>
<tr class="separator:ab22d35ed086a478dd91e93ac78037f40"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4171335401279aad7e5a463349c093c6" id="r_a4171335401279aad7e5a463349c093c6"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file.html#a4171335401279aad7e5a463349c093c6">Capability</a> { <a class="el" href="class_file.html#a4171335401279aad7e5a463349c093c6ad8c3388482873c7d4b65a04d47574fe4">FileRead</a> = BIT(0)
, <a class="el" href="class_file.html#a4171335401279aad7e5a463349c093c6af66a396f05a1ab4fe1cc8d1da442ada4">FileWrite</a> = BIT(1)
 }</td></tr>
<tr class="memdesc:a4171335401279aad7e5a463349c093c6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flags used to indicate what we can do to the file.  <a href="class_file.html#a4171335401279aad7e5a463349c093c6">More...</a><br /></td></tr>
<tr class="separator:a4171335401279aad7e5a463349c093c6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aa2399b233765f85aead662a2f1e67c4b" id="r_aa2399b233765f85aead662a2f1e67c4b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file.html#aa2399b233765f85aead662a2f1e67c4b">File</a> ()</td></tr>
<tr class="memdesc:aa2399b233765f85aead662a2f1e67c4b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor.  <br /></td></tr>
<tr class="separator:aa2399b233765f85aead662a2f1e67c4b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a241d694b0e799c0579a023e76cd97f18" id="r_a241d694b0e799c0579a023e76cd97f18"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file.html#a241d694b0e799c0579a023e76cd97f18">~File</a> ()</td></tr>
<tr class="memdesc:a241d694b0e799c0579a023e76cd97f18"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <br /></td></tr>
<tr class="separator:a241d694b0e799c0579a023e76cd97f18"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1fcc5e785e9af30e2c57e44470308c27" id="r_a1fcc5e785e9af30e2c57e44470308c27"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_file.html#a67a0db04d321a74b7e7fcfd3f1a3f70b">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file.html#a1fcc5e785e9af30e2c57e44470308c27">open</a> (const char *filename, const <a class="el" href="class_file.html#ab22d35ed086a478dd91e93ac78037f40">AccessMode</a> openMode)</td></tr>
<tr class="separator:a1fcc5e785e9af30e2c57e44470308c27"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae91252bdbffcafaefaa6edec813a3c1e" id="r_ae91252bdbffcafaefaa6edec813a3c1e"><td class="memItemLeft" align="right" valign="top">U32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file.html#ae91252bdbffcafaefaa6edec813a3c1e">getPosition</a> () const</td></tr>
<tr class="separator:ae91252bdbffcafaefaa6edec813a3c1e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa2f33f4be57e484f8eff9f03cbd64715" id="r_aa2f33f4be57e484f8eff9f03cbd64715"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_file.html#a67a0db04d321a74b7e7fcfd3f1a3f70b">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file.html#aa2f33f4be57e484f8eff9f03cbd64715">setPosition</a> (S32 position, bool absolutePos=true)</td></tr>
<tr class="separator:aa2f33f4be57e484f8eff9f03cbd64715"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7cc9594fcf9521b946f5a6af63416042" id="r_a7cc9594fcf9521b946f5a6af63416042"><td class="memItemLeft" align="right" valign="top">U32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file.html#a7cc9594fcf9521b946f5a6af63416042">getSize</a> () const</td></tr>
<tr class="memdesc:a7cc9594fcf9521b946f5a6af63416042"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the size of the file.  <br /></td></tr>
<tr class="separator:a7cc9594fcf9521b946f5a6af63416042"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaf503c9e2cda620f95c2e0dd263372bd" id="r_aaf503c9e2cda620f95c2e0dd263372bd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_file.html#a67a0db04d321a74b7e7fcfd3f1a3f70b">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file.html#aaf503c9e2cda620f95c2e0dd263372bd">flush</a> ()</td></tr>
<tr class="separator:aaf503c9e2cda620f95c2e0dd263372bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4e7159a54e5554f196e6e56dc50c765b" id="r_a4e7159a54e5554f196e6e56dc50c765b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_file.html#a67a0db04d321a74b7e7fcfd3f1a3f70b">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file.html#a4e7159a54e5554f196e6e56dc50c765b">close</a> ()</td></tr>
<tr class="separator:a4e7159a54e5554f196e6e56dc50c765b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abdb27e5cb6f722c6e1dc9f145140feae" id="r_abdb27e5cb6f722c6e1dc9f145140feae"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_file.html#a67a0db04d321a74b7e7fcfd3f1a3f70b">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file.html#abdb27e5cb6f722c6e1dc9f145140feae">getStatus</a> () const</td></tr>
<tr class="memdesc:abdb27e5cb6f722c6e1dc9f145140feae"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the status of the file.  <br /></td></tr>
<tr class="separator:abdb27e5cb6f722c6e1dc9f145140feae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac96348f40444e36cfa032bba1dd44b69" id="r_ac96348f40444e36cfa032bba1dd44b69"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_file.html#a67a0db04d321a74b7e7fcfd3f1a3f70b">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file.html#ac96348f40444e36cfa032bba1dd44b69">read</a> (U32 size, char *dst, U32 *bytesRead=NULL)</td></tr>
<tr class="separator:ac96348f40444e36cfa032bba1dd44b69"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1dc73999b04209140aae32a26340f5d8" id="r_a1dc73999b04209140aae32a26340f5d8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_file.html#a67a0db04d321a74b7e7fcfd3f1a3f70b">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file.html#a1dc73999b04209140aae32a26340f5d8">write</a> (U32 size, const char *src, U32 *bytesWritten=NULL)</td></tr>
<tr class="separator:a1dc73999b04209140aae32a26340f5d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8c577f07acd90d9c9e11045a1754ce4a" id="r_a8c577f07acd90d9c9e11045a1754ce4a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file.html#a8c577f07acd90d9c9e11045a1754ce4a">hasCapability</a> (<a class="el" href="class_file.html#a4171335401279aad7e5a463349c093c6">Capability</a> cap) const</td></tr>
<tr class="memdesc:a8c577f07acd90d9c9e11045a1754ce4a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns whether or not this file is capable of the given function.  <br /></td></tr>
<tr class="separator:a8c577f07acd90d9c9e11045a1754ce4a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-methods" name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a33e3229a5b26fa040a6aa2e47d938b4c" id="r_a33e3229a5b26fa040a6aa2e47d938b4c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_file.html#a67a0db04d321a74b7e7fcfd3f1a3f70b">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file.html#a33e3229a5b26fa040a6aa2e47d938b4c">setStatus</a> ()</td></tr>
<tr class="memdesc:a33e3229a5b26fa040a6aa2e47d938b4c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called after error encountered.  <br /></td></tr>
<tr class="separator:a33e3229a5b26fa040a6aa2e47d938b4c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae1cc73e44fece934f01de9f3f594ae10" id="r_ae1cc73e44fece934f01de9f3f594ae10"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_file.html#a67a0db04d321a74b7e7fcfd3f1a3f70b">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_file.html#ae1cc73e44fece934f01de9f3f594ae10">setStatus</a> (<a class="el" href="class_file.html#a67a0db04d321a74b7e7fcfd3f1a3f70b">Status</a> status)</td></tr>
<tr class="memdesc:ae1cc73e44fece934f01de9f3f594ae10"><td class="mdescLeft">&#160;</td><td class="mdescRight">Setter for the current status.  <br /></td></tr>
<tr class="separator:ae1cc73e44fece934f01de9f3f594ae10"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="ab22d35ed086a478dd91e93ac78037f40" name="ab22d35ed086a478dd91e93ac78037f40"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab22d35ed086a478dd91e93ac78037f40">&#9670;&#160;</a></span>AccessMode</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="class_file.html#ab22d35ed086a478dd91e93ac78037f40">AccessMode</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>How are we accessing the file? </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ab22d35ed086a478dd91e93ac78037f40a809abe96853e69894bbf8e5730b31348" name="ab22d35ed086a478dd91e93ac78037f40a809abe96853e69894bbf8e5730b31348"></a>Read&#160;</td><td class="fielddoc"><p>Open for read only, starting at beginning of file. </p>
</td></tr>
<tr><td class="fieldname"><a id="ab22d35ed086a478dd91e93ac78037f40aa56670174817e3fed92bfd8182d7c0d1" name="ab22d35ed086a478dd91e93ac78037f40aa56670174817e3fed92bfd8182d7c0d1"></a>Write&#160;</td><td class="fielddoc"><p>Open for write only, starting at beginning of file; will blast old contents of file. </p>
</td></tr>
<tr><td class="fieldname"><a id="ab22d35ed086a478dd91e93ac78037f40a3c4d2d19c91b345c33a83ca9f551f4e1" name="ab22d35ed086a478dd91e93ac78037f40a3c4d2d19c91b345c33a83ca9f551f4e1"></a>ReadWrite&#160;</td><td class="fielddoc"><p>Open for read-write. </p>
</td></tr>
<tr><td class="fieldname"><a id="ab22d35ed086a478dd91e93ac78037f40a41d36294f7608c7e5565aee5aee6dcf7" name="ab22d35ed086a478dd91e93ac78037f40a41d36294f7608c7e5565aee5aee6dcf7"></a>WriteAppend&#160;</td><td class="fielddoc"><p>Write-only, starting at end of file. </p>
</td></tr>
</table>

</div>
</div>
<a id="a4171335401279aad7e5a463349c093c6" name="a4171335401279aad7e5a463349c093c6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4171335401279aad7e5a463349c093c6">&#9670;&#160;</a></span>Capability</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="class_file.html#a4171335401279aad7e5a463349c093c6">Capability</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Flags used to indicate what we can do to the file. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a4171335401279aad7e5a463349c093c6ad8c3388482873c7d4b65a04d47574fe4" name="a4171335401279aad7e5a463349c093c6ad8c3388482873c7d4b65a04d47574fe4"></a>FileRead&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a4171335401279aad7e5a463349c093c6af66a396f05a1ab4fe1cc8d1da442ada4" name="a4171335401279aad7e5a463349c093c6af66a396f05a1ab4fe1cc8d1da442ada4"></a>FileWrite&#160;</td><td class="fielddoc"></td></tr>
</table>

</div>
</div>
<a id="a67a0db04d321a74b7e7fcfd3f1a3f70b" name="a67a0db04d321a74b7e7fcfd3f1a3f70b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a67a0db04d321a74b7e7fcfd3f1a3f70b">&#9670;&#160;</a></span>Status</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="class_file.html#a67a0db04d321a74b7e7fcfd3f1a3f70b">Status</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>What is the status of our file handle? </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a67a0db04d321a74b7e7fcfd3f1a3f70ba06d32f047358de4e6a30c28046f4688e" name="a67a0db04d321a74b7e7fcfd3f1a3f70ba06d32f047358de4e6a30c28046f4688e"></a>Ok&#160;</td><td class="fielddoc"><p>Ok! </p>
</td></tr>
<tr><td class="fieldname"><a id="a67a0db04d321a74b7e7fcfd3f1a3f70ba53ea0cae152133005a5dbe9a1329765c" name="a67a0db04d321a74b7e7fcfd3f1a3f70ba53ea0cae152133005a5dbe9a1329765c"></a>IOError&#160;</td><td class="fielddoc"><p>Read or Write error. </p>
</td></tr>
<tr><td class="fieldname"><a id="a67a0db04d321a74b7e7fcfd3f1a3f70bae4953b2aea10c683c1f4990a11e01d4d" name="a67a0db04d321a74b7e7fcfd3f1a3f70bae4953b2aea10c683c1f4990a11e01d4d"></a>EOS&#160;</td><td class="fielddoc"><p>End of <a class="el" href="class_stream.html" title="Base stream class for streaming data across a specific media.">Stream</a> reached (mostly for reads) </p>
</td></tr>
<tr><td class="fieldname"><a id="a67a0db04d321a74b7e7fcfd3f1a3f70baa359c7ce2440768125c74d431817548a" name="a67a0db04d321a74b7e7fcfd3f1a3f70baa359c7ce2440768125c74d431817548a"></a>IllegalCall&#160;</td><td class="fielddoc"><p>An unsupported operation used. Always accompanied by AssertWarn. </p>
</td></tr>
<tr><td class="fieldname"><a id="a67a0db04d321a74b7e7fcfd3f1a3f70ba30c0b4dad1e3a3b93f822b9cef26244b" name="a67a0db04d321a74b7e7fcfd3f1a3f70ba30c0b4dad1e3a3b93f822b9cef26244b"></a>Closed&#160;</td><td class="fielddoc"><p>Tried to operate on a closed stream (or detached filter) </p>
</td></tr>
<tr><td class="fieldname"><a id="a67a0db04d321a74b7e7fcfd3f1a3f70ba36b13bee92e122caddcb8abefb6eec31" name="a67a0db04d321a74b7e7fcfd3f1a3f70ba36b13bee92e122caddcb8abefb6eec31"></a>UnknownError&#160;</td><td class="fielddoc"><p>Catchall. </p>
</td></tr>
</table>

</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="aa2399b233765f85aead662a2f1e67c4b" name="aa2399b233765f85aead662a2f1e67c4b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa2399b233765f85aead662a2f1e67c4b">&#9670;&#160;</a></span>File()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_file.html">File</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Default constructor. </p>

</div>
</div>
<a id="a241d694b0e799c0579a023e76cd97f18" name="a241d694b0e799c0579a023e76cd97f18"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a241d694b0e799c0579a023e76cd97f18">&#9670;&#160;</a></span>~File()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">~<a class="el" href="class_file.html">File</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Destructor. </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a4e7159a54e5554f196e6e56dc50c765b" name="a4e7159a54e5554f196e6e56dc50c765b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4e7159a54e5554f196e6e56dc50c765b">&#9670;&#160;</a></span>close()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_file.html#a67a0db04d321a74b7e7fcfd3f1a3f70b">File::Status</a> close </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Closes the file</p>
<dl class="section return"><dt>Returns</dt><dd>The status of the file. </dd></dl>

</div>
</div>
<a id="aaf503c9e2cda620f95c2e0dd263372bd" name="aaf503c9e2cda620f95c2e0dd263372bd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaf503c9e2cda620f95c2e0dd263372bd">&#9670;&#160;</a></span>flush()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_file.html#a67a0db04d321a74b7e7fcfd3f1a3f70b">File::Status</a> flush </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Make sure everything that's supposed to be written to the file gets written.</p>
<dl class="section return"><dt>Returns</dt><dd>The status of the file. </dd></dl>

</div>
</div>
<a id="ae91252bdbffcafaefaa6edec813a3c1e" name="ae91252bdbffcafaefaa6edec813a3c1e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae91252bdbffcafaefaa6edec813a3c1e">&#9670;&#160;</a></span>getPosition()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">U32 getPosition </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Gets the current position in the file</p>
<p>This is in bytes from the beginning of the file. </p>

</div>
</div>
<a id="a7cc9594fcf9521b946f5a6af63416042" name="a7cc9594fcf9521b946f5a6af63416042"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7cc9594fcf9521b946f5a6af63416042">&#9670;&#160;</a></span>getSize()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">U32 getSize </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns the size of the file. </p>

</div>
</div>
<a id="abdb27e5cb6f722c6e1dc9f145140feae" name="abdb27e5cb6f722c6e1dc9f145140feae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abdb27e5cb6f722c6e1dc9f145140feae">&#9670;&#160;</a></span>getStatus()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_file.html#a67a0db04d321a74b7e7fcfd3f1a3f70b">File::Status</a> getStatus </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Gets the status of the file. </p>

</div>
</div>
<a id="a8c577f07acd90d9c9e11045a1754ce4a" name="a8c577f07acd90d9c9e11045a1754ce4a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8c577f07acd90d9c9e11045a1754ce4a">&#9670;&#160;</a></span>hasCapability()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool hasCapability </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_file.html#a4171335401279aad7e5a463349c093c6">Capability</a>&#160;</td>
          <td class="paramname"><em>cap</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns whether or not this file is capable of the given function. </p>

</div>
</div>
<a id="a1fcc5e785e9af30e2c57e44470308c27" name="a1fcc5e785e9af30e2c57e44470308c27"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1fcc5e785e9af30e2c57e44470308c27">&#9670;&#160;</a></span>open()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_file.html#a67a0db04d321a74b7e7fcfd3f1a3f70b">File::Status</a> open </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>filename</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="class_file.html#ab22d35ed086a478dd91e93ac78037f40">AccessMode</a>&#160;</td>
          <td class="paramname"><em>openMode</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Opens a file for access using the specified AccessMode</p>
<dl class="section return"><dt>Returns</dt><dd>The status of the file </dd></dl>

</div>
</div>
<a id="ac96348f40444e36cfa032bba1dd44b69" name="ac96348f40444e36cfa032bba1dd44b69"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac96348f40444e36cfa032bba1dd44b69">&#9670;&#160;</a></span>read()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_file.html#a67a0db04d321a74b7e7fcfd3f1a3f70b">File::Status</a> read </td>
          <td>(</td>
          <td class="paramtype">U32&#160;</td>
          <td class="paramname"><em>size</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>dst</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">U32 *&#160;</td>
          <td class="paramname"><em>bytesRead</em> = <code>NULL</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Reads "size" bytes from the file, and dumps data into "dst". The number of actual bytes read is returned in bytesRead </p><dl class="section return"><dt>Returns</dt><dd>The status of the file </dd></dl>

</div>
</div>
<a id="aa2f33f4be57e484f8eff9f03cbd64715" name="aa2f33f4be57e484f8eff9f03cbd64715"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa2f33f4be57e484f8eff9f03cbd64715">&#9670;&#160;</a></span>setPosition()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_file.html#a67a0db04d321a74b7e7fcfd3f1a3f70b">File::Status</a> setPosition </td>
          <td>(</td>
          <td class="paramtype">S32&#160;</td>
          <td class="paramname"><em>position</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>absolutePos</em> = <code>true</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Sets the current position in the file.</p>
<p>You can set either a relative or absolute position to go to in the file.</p>
<div class="fragment"><div class="line"><a class="code hl_class" href="class_file.html">File</a> *foo;</div>
<div class="line"> </div>
<div class="line">... set up file ...</div>
<div class="line"> </div>
<div class="line"><span class="comment">// Go to byte 32 in the file...</span></div>
<div class="line">foo-&gt;setPosition(32);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// Now skip back 20 bytes...</span></div>
<div class="line">foo-&gt;<a class="code hl_function" href="class_file.html#aa2f33f4be57e484f8eff9f03cbd64715">setPosition</a>(-20, <span class="keyword">false</span>);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// And forward 17...</span></div>
<div class="line">foo-&gt;<a class="code hl_function" href="class_file.html#aa2f33f4be57e484f8eff9f03cbd64715">setPosition</a>(17, <span class="keyword">false</span>);</div>
<div class="ttc" id="aclass_file_html"><div class="ttname"><a href="class_file.html">File</a></div><div class="ttdef"><b>Definition</b> platformFileIO.h:35</div></div>
<div class="ttc" id="aclass_file_html_aa2f33f4be57e484f8eff9f03cbd64715"><div class="ttname"><a href="class_file.html#aa2f33f4be57e484f8eff9f03cbd64715">File::setPosition</a></div><div class="ttdeci">Status setPosition(S32 position, bool absolutePos=true)</div><div class="ttdef"><b>Definition</b> AndroidFileio.cpp:314</div></div>
</div><!-- fragment --><dl class="section return"><dt>Returns</dt><dd>The status of the file </dd></dl>

</div>
</div>
<a id="a33e3229a5b26fa040a6aa2e47d938b4c" name="a33e3229a5b26fa040a6aa2e47d938b4c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a33e3229a5b26fa040a6aa2e47d938b4c">&#9670;&#160;</a></span>setStatus() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_file.html#a67a0db04d321a74b7e7fcfd3f1a3f70b">File::Status</a> setStatus </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Called after error encountered. </p>

</div>
</div>
<a id="ae1cc73e44fece934f01de9f3f594ae10" name="ae1cc73e44fece934f01de9f3f594ae10"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae1cc73e44fece934f01de9f3f594ae10">&#9670;&#160;</a></span>setStatus() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_file.html#a67a0db04d321a74b7e7fcfd3f1a3f70b">File::Status</a> setStatus </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_file.html#a67a0db04d321a74b7e7fcfd3f1a3f70b">File::Status</a>&#160;</td>
          <td class="paramname"><em>status</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Setter for the current status. </p>

</div>
</div>
<a id="a1dc73999b04209140aae32a26340f5d8" name="a1dc73999b04209140aae32a26340f5d8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1dc73999b04209140aae32a26340f5d8">&#9670;&#160;</a></span>write()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_file.html#a67a0db04d321a74b7e7fcfd3f1a3f70b">File::Status</a> write </td>
          <td>(</td>
          <td class="paramtype">U32&#160;</td>
          <td class="paramname"><em>size</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>src</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">U32 *&#160;</td>
          <td class="paramname"><em>bytesWritten</em> = <code>NULL</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Writes "size" bytes into the file from the pointer "src". The number of actual bytes written is returned in bytesWritten </p><dl class="section return"><dt>Returns</dt><dd>The status of the file </dd></dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>platform/<b>platformFileIO.h</b></li>
<li>platformAndroid/<b>AndroidFileio.cpp</b></li>
<li>platformEmscripten/<b>EmscriptenFileio.cpp</b></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>