TorqueEngine
/
Torque2D
mirror of https://github.com/TorqueGameEngines/Torque2D.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757
							<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>FileSystem</title>
<link href="torquedoc.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<table width="100%" class="header">
<tr>
</tr>
<tr><td class="headermenu">
	<center>
	<a class="qindex" href="index.html">Main</a> &nbsp; 
	<a class="qindex" target="_blank" href="https://github.com/GarageGames/Torque2D">GitHub</a>
	</center>
</td></tr>
</table>
<br>
<!-- END HEADER -->
<!-- Generated by Doxygen 1.8.3.1 -->
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">FileSystem</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga16b0e7c2d479c2d800e1ab5ded4a9878"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystem.html#ga16b0e7c2d479c2d800e1ab5ded4a9878">createPath</a> (&quot;file name or path name&quot;)</td></tr>
<tr class="separator:ga16b0e7c2d479c2d800e1ab5ded4a9878"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac32f18d4b4c96a6149dfd64f7bc68262"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystem.html#gac32f18d4b4c96a6149dfd64f7bc68262">directoryDelete</a> (directoryName)</td></tr>
<tr class="separator:gac32f18d4b4c96a6149dfd64f7bc68262"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf93acfae17cbfa3d87d57ecafe57a098"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystem.html#gaf93acfae17cbfa3d87d57ecafe57a098">fileBase</a> (<a class="el" href="group__FileSystem.html#ga71bebb057a0d6ad1c522cd19584b51d9">fileName</a>)</td></tr>
<tr class="separator:gaf93acfae17cbfa3d87d57ecafe57a098"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8f8ffe55b5585cee995f2cd5f13f6897"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystem.html#ga8f8ffe55b5585cee995f2cd5f13f6897">fileDelete</a> (<a class="el" href="group__FileSystem.html#ga71bebb057a0d6ad1c522cd19584b51d9">fileName</a>)</td></tr>
<tr class="separator:ga8f8ffe55b5585cee995f2cd5f13f6897"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga478cf941b39a67a607959e9e925a58dc"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystem.html#ga478cf941b39a67a607959e9e925a58dc">fileExt</a> (<a class="el" href="group__FileSystem.html#ga71bebb057a0d6ad1c522cd19584b51d9">fileName</a>)</td></tr>
<tr class="separator:ga478cf941b39a67a607959e9e925a58dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga71bebb057a0d6ad1c522cd19584b51d9"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystem.html#ga71bebb057a0d6ad1c522cd19584b51d9">fileName</a> (filePathName)</td></tr>
<tr class="separator:ga71bebb057a0d6ad1c522cd19584b51d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa31ccd6561fdd3ce010956b05331795c"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystem.html#gaa31ccd6561fdd3ce010956b05331795c">filePath</a> (<a class="el" href="group__FileSystem.html#ga71bebb057a0d6ad1c522cd19584b51d9">fileName</a>)</td></tr>
<tr class="separator:gaa31ccd6561fdd3ce010956b05331795c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga025bfbc39559ec48f82d73dcb17c2cb8"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystem.html#ga025bfbc39559ec48f82d73dcb17c2cb8">fileSize</a> (<a class="el" href="group__FileSystem.html#ga71bebb057a0d6ad1c522cd19584b51d9">fileName</a>)</td></tr>
<tr class="separator:ga025bfbc39559ec48f82d73dcb17c2cb8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaea0eb550be53aaa5221d8c98a2741a0a"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystem.html#gaea0eb550be53aaa5221d8c98a2741a0a">findFirstFile</a> (strPattern)</td></tr>
<tr class="separator:gaea0eb550be53aaa5221d8c98a2741a0a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8cd2ff98f8ba27b58930d2cef8081d72"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystem.html#ga8cd2ff98f8ba27b58930d2cef8081d72">findFirstFileMultiExpr</a> (strPattern)</td></tr>
<tr class="separator:ga8cd2ff98f8ba27b58930d2cef8081d72"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf136d731a683082f27c2e98121f95ff2"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystem.html#gaf136d731a683082f27c2e98121f95ff2">findNextFile</a> (strPattern)</td></tr>
<tr class="separator:gaf136d731a683082f27c2e98121f95ff2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga06e175fb0e1932859f29eb458b4b632a"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystem.html#ga06e175fb0e1932859f29eb458b4b632a">findNextFileMultiExpr</a> (string pattern)</td></tr>
<tr class="separator:ga06e175fb0e1932859f29eb458b4b632a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2efc72629885e6781e39cfb2c8858fc5"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystem.html#ga2efc72629885e6781e39cfb2c8858fc5">getCurrentDate</a> (bool reverse)</td></tr>
<tr class="separator:ga2efc72629885e6781e39cfb2c8858fc5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaac6cdd11eb85de72f0646f27da108152"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystem.html#gaac6cdd11eb85de72f0646f27da108152">getCurrentDirectory</a> ()</td></tr>
<tr class="separator:gaac6cdd11eb85de72f0646f27da108152"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6ad7539aba848ceb2ca1d8856232d320"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystem.html#ga6ad7539aba848ceb2ca1d8856232d320">getDirectoryList</a> (strPath,[intDepth])</td></tr>
<tr class="separator:ga6ad7539aba848ceb2ca1d8856232d320"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga02a24eeb379f1f7715e36c0d03873cfd"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystem.html#ga02a24eeb379f1f7715e36c0d03873cfd">getExecutableName</a> ()</td></tr>
<tr class="separator:ga02a24eeb379f1f7715e36c0d03873cfd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga06b4232795c900585d5e6bc67dbb8c78"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystem.html#ga06b4232795c900585d5e6bc67dbb8c78">getFileCount</a> (strPattern)</td></tr>
<tr class="separator:ga06b4232795c900585d5e6bc67dbb8c78"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga266f46a6c2adcabfa5612d657d65a471"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystem.html#ga266f46a6c2adcabfa5612d657d65a471">getFileCountMultiExpr</a> (strPattern)</td></tr>
<tr class="separator:ga266f46a6c2adcabfa5612d657d65a471"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac98e36fd3fae75b8fed475fcd2112341"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystem.html#gac98e36fd3fae75b8fed475fcd2112341">getFileCRC</a> (filename)</td></tr>
<tr class="separator:gac98e36fd3fae75b8fed475fcd2112341"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5740551dfacc700ddf69c4e2facd36fa"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystem.html#ga5740551dfacc700ddf69c4e2facd36fa">getFileList</a> (strPath)</td></tr>
<tr class="separator:ga5740551dfacc700ddf69c4e2facd36fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf26b6357b62e4ac827f3b2d6f965fd5b"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystem.html#gaf26b6357b62e4ac827f3b2d6f965fd5b">getMainDotCsDir</a> ()</td></tr>
<tr class="separator:gaf26b6357b62e4ac827f3b2d6f965fd5b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabe9b77ec3d047aed53f75598d716f199"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystem.html#gabe9b77ec3d047aed53f75598d716f199">isDirectory</a> (path)</td></tr>
<tr class="separator:gabe9b77ec3d047aed53f75598d716f199"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga47652fce24570ea88dbe4b872a68f053"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystem.html#ga47652fce24570ea88dbe4b872a68f053">isFile</a> (<a class="el" href="group__FileSystem.html#ga71bebb057a0d6ad1c522cd19584b51d9">fileName</a>)</td></tr>
<tr class="separator:ga47652fce24570ea88dbe4b872a68f053"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4bf17c60cfe8af8760b494bb29549df4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystem.html#ga4bf17c60cfe8af8760b494bb29549df4">isValidImageFile</a> (string <a class="el" href="group__FileSystem.html#gaa31ccd6561fdd3ce010956b05331795c">filePath</a>)</td></tr>
<tr class="separator:ga4bf17c60cfe8af8760b494bb29549df4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3e65bc874f8c642d86dcbf483c0306d6"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystem.html#ga3e65bc874f8c642d86dcbf483c0306d6">isWriteableFileName</a> (<a class="el" href="group__FileSystem.html#ga71bebb057a0d6ad1c522cd19584b51d9">fileName</a>)</td></tr>
<tr class="separator:ga3e65bc874f8c642d86dcbf483c0306d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga51759c737be5e7ac5964ba5ea80a217a"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystem.html#ga51759c737be5e7ac5964ba5ea80a217a">makeFullPath</a> (string path,[string currentWorkingDir])</td></tr>
<tr class="separator:ga51759c737be5e7ac5964ba5ea80a217a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gacdc18653fe1309da7b14f1c23447f68b"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystem.html#gacdc18653fe1309da7b14f1c23447f68b">makeRelativePath</a> (string path, string to)</td></tr>
<tr class="separator:gacdc18653fe1309da7b14f1c23447f68b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6b54b05ab3f4d5b059bfd2dcca73b561"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystem.html#ga6b54b05ab3f4d5b059bfd2dcca73b561">pathConcat</a> (string path, string file1,[...fileN])</td></tr>
<tr class="separator:ga6b54b05ab3f4d5b059bfd2dcca73b561"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad2338aaec57b7e000a974fe7427410aa"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystem.html#gad2338aaec57b7e000a974fe7427410aa">pathCopy</a> (fromFile, toFile[, nooverwrite=true])</td></tr>
<tr class="separator:gad2338aaec57b7e000a974fe7427410aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga55cac30dc1287e0d4ed638af5797c9e8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystem.html#ga55cac30dc1287e0d4ed638af5797c9e8">restartInstance</a> ()</td></tr>
<tr class="separator:ga55cac30dc1287e0d4ed638af5797c9e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga72da6dda87dc9fd1c4e6b4d61a682602"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystem.html#ga72da6dda87dc9fd1c4e6b4d61a682602">setCurrentDirectory</a> (absolutePathName)</td></tr>
<tr class="separator:ga72da6dda87dc9fd1c4e6b4d61a682602"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Functions allowing you to search for files, read them, write them, and access their properties. </p>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga16b0e7c2d479c2d800e1ab5ded4a9878"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool createPath </td>
          <td>(</td>
          <td class="paramtype">&quot;file name or path name&quot;&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="gac32f18d4b4c96a6149dfd64f7bc68262"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool directoryDelete </td>
          <td>(</td>
          <td class="paramtype">directoryName&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">directoryName</td><td>Name of the directory to remove</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns true on success and false on failure </dd></dl>

</div>
</div>
<a class="anchor" id="gaf93acfae17cbfa3d87d57ecafe57a098"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">string fileBase </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__FileSystem.html#ga71bebb057a0d6ad1c522cd19584b51d9">fileName</a>&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="ga8f8ffe55b5585cee995f2cd5f13f6897"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool fileDelete </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__FileSystem.html#ga71bebb057a0d6ad1c522cd19584b51d9">fileName</a>&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">fileName</td><td>Name of the file to remove</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns true on success and false on failure </dd></dl>

</div>
</div>
<a class="anchor" id="ga478cf941b39a67a607959e9e925a58dc"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">string fileExt </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__FileSystem.html#ga71bebb057a0d6ad1c522cd19584b51d9">fileName</a>&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">Name</td><td>of file from which to extract extension </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A string containing the file's extension (assuming all data after first '.' is the extension) or returns empty string on failure </dd></dl>

</div>
</div>
<a class="anchor" id="ga71bebb057a0d6ad1c522cd19584b51d9"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">string fileName </td>
          <td>(</td>
          <td class="paramtype">filePathName&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Extract the filename from the full path description </p>

</div>
</div>
<a class="anchor" id="gaa31ccd6561fdd3ce010956b05331795c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">string filePath </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__FileSystem.html#ga71bebb057a0d6ad1c522cd19584b51d9">fileName</a>&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Extract the file path from a file's full desciption </p>

</div>
</div>
<a class="anchor" id="ga025bfbc39559ec48f82d73dcb17c2cb8"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int fileSize </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__FileSystem.html#ga71bebb057a0d6ad1c522cd19584b51d9">fileName</a>&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">fileName</td><td>The name of the file to check. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns the size of the file as an integer or -1 if file not found </dd></dl>

</div>
</div>
<a class="anchor" id="gaea0eb550be53aaa5221d8c98a2741a0a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">string findFirstFile </td>
          <td>(</td>
          <td class="paramtype">strPattern&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">strPattern</td><td>The string pattern to search for. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a string representing the first file in the directory system matching the given pattern. </dd></dl>

</div>
</div>
<a class="anchor" id="ga8cd2ff98f8ba27b58930d2cef8081d72"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">string findFirstFileMultiExpr </td>
          <td>(</td>
          <td class="paramtype">strPattern&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">strPattern</td><td>The string pattern to search for. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns the first file in the directory system matching the given pattern. </dd></dl>

</div>
</div>
<a class="anchor" id="gaf136d731a683082f27c2e98121f95ff2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">string findNextFile </td>
          <td>(</td>
          <td class="paramtype">strPattern&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">strPattern</td><td>The string pattern to search for. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns the next file matching a search begun in findFirstFile. </dd></dl>

</div>
</div>
<a class="anchor" id="ga06e175fb0e1932859f29eb458b4b632a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">string findNextFileMultiExpr </td>
          <td>(</td>
          <td class="paramtype">string&#160;</td>
          <td class="paramname"><em>pattern</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Returns the next file matching a search begun in findFirstFile. </p>

</div>
</div>
<a class="anchor" id="ga2efc72629885e6781e39cfb2c8858fc5"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">string getCurrentDate </td>
          <td>(</td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>reverse</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Gets the current date and time. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">reverse</td><td>Determines if the format will be Month/Day/Year/Hour:Min:Seconds or Year/Month/Day/Hour:Min:Seconds </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="gaac6cdd11eb85de72f0646f27da108152"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">string getCurrentDirectory </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="ga6ad7539aba848ceb2ca1d8856232d320"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">string getDirectoryList </td>
          <td>(</td>
          <td class="paramtype">strPath&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">strPath</td><td>The path in which to check </td></tr>
    <tr><td class="paramname">intDepth</td><td>The depth in which to return (default 0 if not specified) </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The directory contents </dd></dl>

</div>
</div>
<a class="anchor" id="ga02a24eeb379f1f7715e36c0d03873cfd"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">string getExecutableName </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="ga06b4232795c900585d5e6bc67dbb8c78"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int getFileCount </td>
          <td>(</td>
          <td class="paramtype">strPattern&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">strPattern</td><td>The string pattern to search for. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns the number of files in the directory tree that match the given pattern </dd></dl>

</div>
</div>
<a class="anchor" id="ga266f46a6c2adcabfa5612d657d65a471"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int getFileCountMultiExpr </td>
          <td>(</td>
          <td class="paramtype">strPattern&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">strPattern</td><td>The string pattern to search for. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns the number of files in the directory tree that match the given pattern </dd></dl>

</div>
</div>
<a class="anchor" id="gac98e36fd3fae75b8fed475fcd2112341"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int getFileCRC </td>
          <td>(</td>
          <td class="paramtype">filename&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">filename</td><td>The string representing the file from which to get the CRC </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>An integer </dd></dl>

</div>
</div>
<a class="anchor" id="ga5740551dfacc700ddf69c4e2facd36fa"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">string getFileList </td>
          <td>(</td>
          <td class="paramtype">strPath&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<ul>
<li>Gets all the files in the specified directory. <dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">strPath</td><td>The path in which to check </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A list of files in the specified directory. </dd></dl>
</li>
</ul>

</div>
</div>
<a class="anchor" id="gaf26b6357b62e4ac827f3b2d6f965fd5b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">string getMainDotCsDir </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="gabe9b77ec3d047aed53f75598d716f199"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool isDirectory </td>
          <td>(</td>
          <td class="paramtype">path&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">pathName</td><td>Path to check. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns true if the given path is a folder/directory, false otherwise </dd></dl>

</div>
</div>
<a class="anchor" id="ga47652fce24570ea88dbe4b872a68f053"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool isFile </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__FileSystem.html#ga71bebb057a0d6ad1c522cd19584b51d9">fileName</a>&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">fileName</td><td>Filename to check. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns true if the given filename is an existing file or false otherwise </dd></dl>

</div>
</div>
<a class="anchor" id="ga4bf17c60cfe8af8760b494bb29549df4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool isValidImageFile </td>
          <td>(</td>
          <td class="paramtype">string&#160;</td>
          <td class="paramname"><em>filePath</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">filePath</td><td>Full path of file to check. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns true if the given filename is a valid image file or false otherwise </dd></dl>

</div>
</div>
<a class="anchor" id="ga3e65bc874f8c642d86dcbf483c0306d6"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool isWriteableFileName </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__FileSystem.html#ga71bebb057a0d6ad1c522cd19584b51d9">fileName</a>&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">fileName</td><td>Filename to check. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns true if the given filename is an existing file and is not Read-Only or false otherwise </dd></dl>

</div>
</div>
<a class="anchor" id="ga51759c737be5e7ac5964ba5ea80a217a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">string makeFullPath </td>
          <td>(</td>
          <td class="paramtype">string&#160;</td>
          <td class="paramname"><em>path</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="gacdc18653fe1309da7b14f1c23447f68b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">string makeRelativePath </td>
          <td>(</td>
          <td class="paramtype">string&#160;</td>
          <td class="paramname"><em>path</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">string&#160;</td>
          <td class="paramname"><em>to</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="ga6b54b05ab3f4d5b059bfd2dcca73b561"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">string pathConcat </td>
          <td>(</td>
          <td class="paramtype">string&#160;</td>
          <td class="paramname"><em>path</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">string&#160;</td>
          <td class="paramname"><em>file1</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="gad2338aaec57b7e000a974fe7427410aa"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool pathCopy </td>
          <td>(</td>
          <td class="paramtype">fromFile&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">toFile&#160;</td>
          <td class="paramname">[, nooverwrite=true]&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="ga55cac30dc1287e0d4ed638af5797c9e8"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void restartInstance </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="ga72da6dda87dc9fd1c4e6b4d61a682602"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool setCurrentDirectory </td>
          <td>(</td>
          <td class="paramtype">absolutePathName&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
</div><!-- contents -->
<!-- START FOOTER -->
<br>
<br>
<center>
	<div style="color: #777777;">
	Copyright &copy; 2013 <a style="color: #777777;" target="_blank" href="http://www.garagegames.com">GarageGames, LLC</a>. All Rights Reserved.
	</div>
</center>
</body>
</html>