Home Explore Help
Sign In
TorqueEngine
/
Torque2D
mirror of https://github.com/TorqueGameEngines/Torque2D.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: b900bca24a
Branches Tags
Torque2D
/
TorqueScriptDocs
/
html
/
group__FileSystemFunctions.html

group__FileSystemFunctions.html 37 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820 
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    2. 

  2. <html xmlns="http://www.w3.org/1999/xhtml">
    3. 

  3. <head>
    4. 

  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
    5. 

  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
    6. 

  6. <meta name="generator" content="Doxygen 1.8.3.1"/>
    7. 

  7. <title>TorqueScript Reference: File System</title>
    8. 

  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
    9. 

  9. <script type="text/javascript" src="jquery.js"></script>
    10. 

  10. <script type="text/javascript" src="dynsections.js"></script>
    11. 

  11. <link href="doxygen.css" rel="stylesheet" type="text/css" />
    12. 

  12. <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
    13. 

  13. </head>
    14. 

  14. <body>
    15. 

  15. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
    16. 

  16. <div id="titlearea">
    17. 

  17. <table cellspacing="0" cellpadding="0">
    18. 

  18.  <tbody>
    19. 

  19.  <tr style="height: 56px;">
    20. 

  20.   <td style="padding-left: 0.5em;">
    21. 

  21.    <div id="projectname">TorqueScript Reference
    22. 

  22.    </div>
    23. 

  23.   </td>
    24. 

  24.  </tr>
    25. 

  25.  </tbody>
    26. 

  26. </table>
    27. 

  27. </div>
    28. 

  28. <!-- end header part -->
    29. 

  29. <!-- Generated by Doxygen 1.8.3.1 -->
    30. 

  30.   <div id="navrow1" class="tabs">
    31. 

  31.     <ul class="tablist">
    32. 

  32.       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
    33. 

  33.       <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
    34. 

  34.       <li><a href="modules.html"><span>Modules</span></a></li>
    35. 

  35.       <li><a href="annotated.html"><span>Classes</span></a></li>
    36. 

  36.     </ul>
    37. 

  37.   </div>
    38. 

  38. </div><!-- top -->
    39. 

  39. <div class="header">
    40. 

  40.   <div class="summary">
    41. 

  41. <a href="#func-members">Functions</a>  </div>
    42. 

  42.   <div class="headertitle">
    43. 

  43. <div class="title">File System<div class="ingroups"><a class="el" href="group__TorqueScriptFunctions.html">Function Categories</a></div></div>  </div>
    44. 

  44. </div><!--header-->
    45. 

  45. <div class="contents">
    46. 

  46. <table class="memberdecls">
    47. 

  47. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
    48. 

  48. Functions</h2></td></tr>
    49. 

  49. <tr class="memitem:ga02b64720518621007ef07f2690843eb3"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystemFunctions.html#ga02b64720518621007ef07f2690843eb3">createPath</a> (<a class="el" href="group__FileSystemFunctions.html#ga71bebb057a0d6ad1c522cd19584b51d9">fileName</a> or pathName)</td></tr>
    50. 

  50. <tr class="separator:ga02b64720518621007ef07f2690843eb3"><td class="memSeparator" colspan="2">&#160;</td></tr>
    51. 

  51. <tr class="memitem:gac32f18d4b4c96a6149dfd64f7bc68262"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystemFunctions.html#gac32f18d4b4c96a6149dfd64f7bc68262">directoryDelete</a> (directoryName)</td></tr>
    52. 

  52. <tr class="separator:gac32f18d4b4c96a6149dfd64f7bc68262"><td class="memSeparator" colspan="2">&#160;</td></tr>
    53. 

  53. <tr class="memitem:gaf93acfae17cbfa3d87d57ecafe57a098"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystemFunctions.html#gaf93acfae17cbfa3d87d57ecafe57a098">fileBase</a> (<a class="el" href="group__FileSystemFunctions.html#ga71bebb057a0d6ad1c522cd19584b51d9">fileName</a>)</td></tr>
    54. 

  54. <tr class="separator:gaf93acfae17cbfa3d87d57ecafe57a098"><td class="memSeparator" colspan="2">&#160;</td></tr>
    55. 

  55. <tr class="memitem:ga8f8ffe55b5585cee995f2cd5f13f6897"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystemFunctions.html#ga8f8ffe55b5585cee995f2cd5f13f6897">fileDelete</a> (<a class="el" href="group__FileSystemFunctions.html#ga71bebb057a0d6ad1c522cd19584b51d9">fileName</a>)</td></tr>
    56. 

  56. <tr class="separator:ga8f8ffe55b5585cee995f2cd5f13f6897"><td class="memSeparator" colspan="2">&#160;</td></tr>
    57. 

  57. <tr class="memitem:ga478cf941b39a67a607959e9e925a58dc"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystemFunctions.html#ga478cf941b39a67a607959e9e925a58dc">fileExt</a> (<a class="el" href="group__FileSystemFunctions.html#ga71bebb057a0d6ad1c522cd19584b51d9">fileName</a>)</td></tr>
    58. 

  58. <tr class="separator:ga478cf941b39a67a607959e9e925a58dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
    59. 

  59. <tr class="memitem:ga71bebb057a0d6ad1c522cd19584b51d9"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystemFunctions.html#ga71bebb057a0d6ad1c522cd19584b51d9">fileName</a> (filePathName)</td></tr>
    60. 

  60. <tr class="separator:ga71bebb057a0d6ad1c522cd19584b51d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
    61. 

  61. <tr class="memitem:gaa31ccd6561fdd3ce010956b05331795c"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystemFunctions.html#gaa31ccd6561fdd3ce010956b05331795c">filePath</a> (<a class="el" href="group__FileSystemFunctions.html#ga71bebb057a0d6ad1c522cd19584b51d9">fileName</a>)</td></tr>
    62. 

  62. <tr class="separator:gaa31ccd6561fdd3ce010956b05331795c"><td class="memSeparator" colspan="2">&#160;</td></tr>
    63. 

  63. <tr class="memitem:ga025bfbc39559ec48f82d73dcb17c2cb8"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystemFunctions.html#ga025bfbc39559ec48f82d73dcb17c2cb8">fileSize</a> (<a class="el" href="group__FileSystemFunctions.html#ga71bebb057a0d6ad1c522cd19584b51d9">fileName</a>)</td></tr>
    64. 

  64. <tr class="separator:ga025bfbc39559ec48f82d73dcb17c2cb8"><td class="memSeparator" colspan="2">&#160;</td></tr>
    65. 

  65. <tr class="memitem:gaea0eb550be53aaa5221d8c98a2741a0a"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystemFunctions.html#gaea0eb550be53aaa5221d8c98a2741a0a">findFirstFile</a> (strPattern)</td></tr>
    66. 

  66. <tr class="separator:gaea0eb550be53aaa5221d8c98a2741a0a"><td class="memSeparator" colspan="2">&#160;</td></tr>
    67. 

  67. <tr class="memitem:ga8cd2ff98f8ba27b58930d2cef8081d72"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystemFunctions.html#ga8cd2ff98f8ba27b58930d2cef8081d72">findFirstFileMultiExpr</a> (strPattern)</td></tr>
    68. 

  68. <tr class="separator:ga8cd2ff98f8ba27b58930d2cef8081d72"><td class="memSeparator" colspan="2">&#160;</td></tr>
    69. 

  69. <tr class="memitem:gaf136d731a683082f27c2e98121f95ff2"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystemFunctions.html#gaf136d731a683082f27c2e98121f95ff2">findNextFile</a> (strPattern)</td></tr>
    70. 

  70. <tr class="separator:gaf136d731a683082f27c2e98121f95ff2"><td class="memSeparator" colspan="2">&#160;</td></tr>
    71. 

  71. <tr class="memitem:ga06e175fb0e1932859f29eb458b4b632a"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystemFunctions.html#ga06e175fb0e1932859f29eb458b4b632a">findNextFileMultiExpr</a> (string pattern)</td></tr>
    72. 

  72. <tr class="separator:ga06e175fb0e1932859f29eb458b4b632a"><td class="memSeparator" colspan="2">&#160;</td></tr>
    73. 

  73. <tr class="memitem:ga2efc72629885e6781e39cfb2c8858fc5"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystemFunctions.html#ga2efc72629885e6781e39cfb2c8858fc5">getCurrentDate</a> (bool reverse)</td></tr>
    74. 

  74. <tr class="separator:ga2efc72629885e6781e39cfb2c8858fc5"><td class="memSeparator" colspan="2">&#160;</td></tr>
    75. 

  75. <tr class="memitem:gaac6cdd11eb85de72f0646f27da108152"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystemFunctions.html#gaac6cdd11eb85de72f0646f27da108152">getCurrentDirectory</a> ()</td></tr>
    76. 

  76. <tr class="separator:gaac6cdd11eb85de72f0646f27da108152"><td class="memSeparator" colspan="2">&#160;</td></tr>
    77. 

  77. <tr class="memitem:ga7e6bb9bd8782ec0d3387a0df8e25f3c5"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystemFunctions.html#ga7e6bb9bd8782ec0d3387a0df8e25f3c5">getDirectoryList</a> (strPath,[intDepth]?)</td></tr>
    78. 

  78. <tr class="separator:ga7e6bb9bd8782ec0d3387a0df8e25f3c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
    79. 

  79. <tr class="memitem:ga02a24eeb379f1f7715e36c0d03873cfd"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystemFunctions.html#ga02a24eeb379f1f7715e36c0d03873cfd">getExecutableName</a> ()</td></tr>
    80. 

  80. <tr class="separator:ga02a24eeb379f1f7715e36c0d03873cfd"><td class="memSeparator" colspan="2">&#160;</td></tr>
    81. 

  81. <tr class="memitem:ga06b4232795c900585d5e6bc67dbb8c78"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystemFunctions.html#ga06b4232795c900585d5e6bc67dbb8c78">getFileCount</a> (strPattern)</td></tr>
    82. 

  82. <tr class="separator:ga06b4232795c900585d5e6bc67dbb8c78"><td class="memSeparator" colspan="2">&#160;</td></tr>
    83. 

  83. <tr class="memitem:ga266f46a6c2adcabfa5612d657d65a471"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystemFunctions.html#ga266f46a6c2adcabfa5612d657d65a471">getFileCountMultiExpr</a> (strPattern)</td></tr>
    84. 

  84. <tr class="separator:ga266f46a6c2adcabfa5612d657d65a471"><td class="memSeparator" colspan="2">&#160;</td></tr>
    85. 

  85. <tr class="memitem:gac98e36fd3fae75b8fed475fcd2112341"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystemFunctions.html#gac98e36fd3fae75b8fed475fcd2112341">getFileCRC</a> (filename)</td></tr>
    86. 

  86. <tr class="separator:gac98e36fd3fae75b8fed475fcd2112341"><td class="memSeparator" colspan="2">&#160;</td></tr>
    87. 

  87. <tr class="memitem:ga5740551dfacc700ddf69c4e2facd36fa"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystemFunctions.html#ga5740551dfacc700ddf69c4e2facd36fa">getFileList</a> (strPath)</td></tr>
    88. 

  88. <tr class="separator:ga5740551dfacc700ddf69c4e2facd36fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
    89. 

  89. <tr class="memitem:gaf26b6357b62e4ac827f3b2d6f965fd5b"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystemFunctions.html#gaf26b6357b62e4ac827f3b2d6f965fd5b">getMainDotCsDir</a> ()</td></tr>
    90. 

  90. <tr class="separator:gaf26b6357b62e4ac827f3b2d6f965fd5b"><td class="memSeparator" colspan="2">&#160;</td></tr>
    91. 

  91. <tr class="memitem:gabe9b77ec3d047aed53f75598d716f199"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystemFunctions.html#gabe9b77ec3d047aed53f75598d716f199">isDirectory</a> (path)</td></tr>
    92. 

  92. <tr class="separator:gabe9b77ec3d047aed53f75598d716f199"><td class="memSeparator" colspan="2">&#160;</td></tr>
    93. 

  93. <tr class="memitem:ga47652fce24570ea88dbe4b872a68f053"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystemFunctions.html#ga47652fce24570ea88dbe4b872a68f053">isFile</a> (<a class="el" href="group__FileSystemFunctions.html#ga71bebb057a0d6ad1c522cd19584b51d9">fileName</a>)</td></tr>
    94. 

  94. <tr class="separator:ga47652fce24570ea88dbe4b872a68f053"><td class="memSeparator" colspan="2">&#160;</td></tr>
    95. 

  95. <tr class="memitem:ga4bf17c60cfe8af8760b494bb29549df4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystemFunctions.html#ga4bf17c60cfe8af8760b494bb29549df4">isValidImageFile</a> (string <a class="el" href="group__FileSystemFunctions.html#gaa31ccd6561fdd3ce010956b05331795c">filePath</a>)</td></tr>
    96. 

  96. <tr class="separator:ga4bf17c60cfe8af8760b494bb29549df4"><td class="memSeparator" colspan="2">&#160;</td></tr>
    97. 

  97. <tr class="memitem:ga3e65bc874f8c642d86dcbf483c0306d6"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystemFunctions.html#ga3e65bc874f8c642d86dcbf483c0306d6">isWriteableFileName</a> (<a class="el" href="group__FileSystemFunctions.html#ga71bebb057a0d6ad1c522cd19584b51d9">fileName</a>)</td></tr>
    98. 

  98. <tr class="separator:ga3e65bc874f8c642d86dcbf483c0306d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
    99. 

  99. <tr class="memitem:ga678fdc03f838da1f06b86049dc68d1ef"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystemFunctions.html#ga678fdc03f838da1f06b86049dc68d1ef">makeFullPath</a> (string path,[string currentWorkingDir]?)</td></tr>
    100. 

  100. <tr class="separator:ga678fdc03f838da1f06b86049dc68d1ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
    101. 

  101. <tr class="memitem:gacdc18653fe1309da7b14f1c23447f68b"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystemFunctions.html#gacdc18653fe1309da7b14f1c23447f68b">makeRelativePath</a> (string path, string to)</td></tr>
    102. 

  102. <tr class="separator:gacdc18653fe1309da7b14f1c23447f68b"><td class="memSeparator" colspan="2">&#160;</td></tr>
    103. 

  103. <tr class="memitem:ga6ed8d04b39e458d9c96572a615c10c34"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystemFunctions.html#ga6ed8d04b39e458d9c96572a615c10c34">openFolder</a> (path)</td></tr>
    104. 

  104. <tr class="separator:ga6ed8d04b39e458d9c96572a615c10c34"><td class="memSeparator" colspan="2">&#160;</td></tr>
    105. 

  105. <tr class="memitem:ga81b7e2b1be499d11cea942048ad0bb15"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystemFunctions.html#ga81b7e2b1be499d11cea942048ad0bb15">pathConcat</a> (string path, string file1,[...fileN]*)</td></tr>
    106. 

  106. <tr class="separator:ga81b7e2b1be499d11cea942048ad0bb15"><td class="memSeparator" colspan="2">&#160;</td></tr>
    107. 

  107. <tr class="memitem:ga3b01e397c1b597da0ac57f5dcc258d1c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystemFunctions.html#ga3b01e397c1b597da0ac57f5dcc258d1c">pathCopy</a> (fromFile, toFile,[nooverwrite=true]?)</td></tr>
    108. 

  108. <tr class="separator:ga3b01e397c1b597da0ac57f5dcc258d1c"><td class="memSeparator" colspan="2">&#160;</td></tr>
    109. 

  109. <tr class="memitem:ga55cac30dc1287e0d4ed638af5797c9e8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystemFunctions.html#ga55cac30dc1287e0d4ed638af5797c9e8">restartInstance</a> ()</td></tr>
    110. 

  110. <tr class="separator:ga55cac30dc1287e0d4ed638af5797c9e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
    111. 

  111. <tr class="memitem:ga72da6dda87dc9fd1c4e6b4d61a682602"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__FileSystemFunctions.html#ga72da6dda87dc9fd1c4e6b4d61a682602">setCurrentDirectory</a> (absolutePathName)</td></tr>
    112. 

  112. <tr class="separator:ga72da6dda87dc9fd1c4e6b4d61a682602"><td class="memSeparator" colspan="2">&#160;</td></tr>
    113. 

  113. </table>
    114. 

  114. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
    115. 

  115. <h2 class="groupheader">Function Documentation</h2>
    116. 

  116. <a class="anchor" id="ga02b64720518621007ef07f2690843eb3"></a>
    117. 

  117. <div class="memitem">
    118. 

  118. <div class="memproto">
    119. 

  119.       <table class="memname">
    120. 

  120.         <tr>
    121. 

  121.           <td class="memname">bool createPath </td>
    122. 

  122.           <td>(</td>
    123. 

  123.           <td class="paramtype"><a class="el" href="group__FileSystemFunctions.html#ga71bebb057a0d6ad1c522cd19584b51d9">fileName</a> or&#160;</td>
    124. 

  124.           <td class="paramname"><em>pathName</em></td><td>)</td>
    125. 

  125.           <td></td>
    126. 

  126.         </tr>
    127. 

  127.       </table>
    128. 

  128. </div><div class="memdoc">
    129. 

  129. <p>creates the path or path to the file name </p>
    130. 

  130. 

  131. </div>
    132. 

  132. </div>
    133. 

  133. <a class="anchor" id="gac32f18d4b4c96a6149dfd64f7bc68262"></a>
    134. 

  134. <div class="memitem">
    135. 

  135. <div class="memproto">
    136. 

  136.       <table class="memname">
    137. 

  137.         <tr>
    138. 

  138.           <td class="memname">bool directoryDelete </td>
    139. 

  139.           <td>(</td>
    140. 

  140.           <td class="paramtype">directoryName&#160;</td>
    141. 

  141.           <td class="paramname"></td><td>)</td>
    142. 

  142.           <td></td>
    143. 

  143.         </tr>
    144. 

  144.       </table>
    145. 

  145. </div><div class="memdoc">
    146. 

  146. <dl class="params"><dt>Parameters</dt><dd>
    147. 

  147.   <table class="params">
    148. 

  148.     <tr><td class="paramname">directoryName</td><td>Name of the directory to remove </td></tr>
    149. 

  149.   </table>
    150. 

  150.   </dd>
    151. 

  151. </dl>
    152. 

  152. <dl class="section return"><dt>Returns</dt><dd>Returns true on success and false on failure </dd></dl>
    153. 

  153. 

  154. </div>
    155. 

  155. </div>
    156. 

  156. <a class="anchor" id="gaf93acfae17cbfa3d87d57ecafe57a098"></a>
    157. 

  157. <div class="memitem">
    158. 

  158. <div class="memproto">
    159. 

  159.       <table class="memname">
    160. 

  160.         <tr>
    161. 

  161.           <td class="memname">string fileBase </td>
    162. 

  162.           <td>(</td>
    163. 

  163.           <td class="paramtype"><a class="el" href="group__FileSystemFunctions.html#ga71bebb057a0d6ad1c522cd19584b51d9">fileName</a>&#160;</td>
    164. 

  164.           <td class="paramname"></td><td>)</td>
    165. 

  165.           <td></td>
    166. 

  166.         </tr>
    167. 

  167.       </table>
    168. 

  168. </div><div class="memdoc">
    169. 

  169. 

  170. </div>
    171. 

  171. </div>
    172. 

  172. <a class="anchor" id="ga8f8ffe55b5585cee995f2cd5f13f6897"></a>
    173. 

  173. <div class="memitem">
    174. 

  174. <div class="memproto">
    175. 

  175.       <table class="memname">
    176. 

  176.         <tr>
    177. 

  177.           <td class="memname">bool fileDelete </td>
    178. 

  178.           <td>(</td>
    179. 

  179.           <td class="paramtype"><a class="el" href="group__FileSystemFunctions.html#ga71bebb057a0d6ad1c522cd19584b51d9">fileName</a>&#160;</td>
    180. 

  180.           <td class="paramname"></td><td>)</td>
    181. 

  181.           <td></td>
    182. 

  182.         </tr>
    183. 

  183.       </table>
    184. 

  184. </div><div class="memdoc">
    185. 

  185. <dl class="params"><dt>Parameters</dt><dd>
    186. 

  186.   <table class="params">
    187. 

  187.     <tr><td class="paramname">fileName</td><td>Name of the file to remove </td></tr>
    188. 

  188.   </table>
    189. 

  189.   </dd>
    190. 

  190. </dl>
    191. 

  191. <dl class="section return"><dt>Returns</dt><dd>Returns true on success and false on failure </dd></dl>
    192. 

  192. 

  193. </div>
    194. 

  194. </div>
    195. 

  195. <a class="anchor" id="ga478cf941b39a67a607959e9e925a58dc"></a>
    196. 

  196. <div class="memitem">
    197. 

  197. <div class="memproto">
    198. 

  198.       <table class="memname">
    199. 

  199.         <tr>
    200. 

  200.           <td class="memname">string fileExt </td>
    201. 

  201.           <td>(</td>
    202. 

  202.           <td class="paramtype"><a class="el" href="group__FileSystemFunctions.html#ga71bebb057a0d6ad1c522cd19584b51d9">fileName</a>&#160;</td>
    203. 

  203.           <td class="paramname"></td><td>)</td>
    204. 

  204.           <td></td>
    205. 

  205.         </tr>
    206. 

  206.       </table>
    207. 

  207. </div><div class="memdoc">
    208. 

  208. <dl class="params"><dt>Parameters</dt><dd>
    209. 

  209.   <table class="params">
    210. 

  210.     <tr><td class="paramname">Name</td><td>of file from which to extract extension </td></tr>
    211. 

  211.   </table>
    212. 

  212.   </dd>
    213. 

  213. </dl>
    214. 

  214. <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>
    215. 

  215. 

  216. </div>
    217. 

  217. </div>
    218. 

  218. <a class="anchor" id="ga71bebb057a0d6ad1c522cd19584b51d9"></a>
    219. 

  219. <div class="memitem">
    220. 

  220. <div class="memproto">
    221. 

  221.       <table class="memname">
    222. 

  222.         <tr>
    223. 

  223.           <td class="memname">string fileName </td>
    224. 

  224.           <td>(</td>
    225. 

  225.           <td class="paramtype">filePathName&#160;</td>
    226. 

  226.           <td class="paramname"></td><td>)</td>
    227. 

  227.           <td></td>
    228. 

  228.         </tr>
    229. 

  229.       </table>
    230. 

  230. </div><div class="memdoc">
    231. 

  231. <p>Extract the filename from the full path description </p>
    232. 

  232. 

  233. </div>
    234. 

  234. </div>
    235. 

  235. <a class="anchor" id="gaa31ccd6561fdd3ce010956b05331795c"></a>
    236. 

  236. <div class="memitem">
    237. 

  237. <div class="memproto">
    238. 

  238.       <table class="memname">
    239. 

  239.         <tr>
    240. 

  240.           <td class="memname">string filePath </td>
    241. 

  241.           <td>(</td>
    242. 

  242.           <td class="paramtype"><a class="el" href="group__FileSystemFunctions.html#ga71bebb057a0d6ad1c522cd19584b51d9">fileName</a>&#160;</td>
    243. 

  243.           <td class="paramname"></td><td>)</td>
    244. 

  244.           <td></td>
    245. 

  245.         </tr>
    246. 

  246.       </table>
    247. 

  247. </div><div class="memdoc">
    248. 

  248. <p>Extract the file path from a file's full desciption </p>
    249. 

  249. 

  250. </div>
    251. 

  251. </div>
    252. 

  252. <a class="anchor" id="ga025bfbc39559ec48f82d73dcb17c2cb8"></a>
    253. 

  253. <div class="memitem">
    254. 

  254. <div class="memproto">
    255. 

  255.       <table class="memname">
    256. 

  256.         <tr>
    257. 

  257.           <td class="memname">int fileSize </td>
    258. 

  258.           <td>(</td>
    259. 

  259.           <td class="paramtype"><a class="el" href="group__FileSystemFunctions.html#ga71bebb057a0d6ad1c522cd19584b51d9">fileName</a>&#160;</td>
    260. 

  260.           <td class="paramname"></td><td>)</td>
    261. 

  261.           <td></td>
    262. 

  262.         </tr>
    263. 

  263.       </table>
    264. 

  264. </div><div class="memdoc">
    265. 

  265. <dl class="params"><dt>Parameters</dt><dd>
    266. 

  266.   <table class="params">
    267. 

  267.     <tr><td class="paramname">fileName</td><td>The name of the file to check. </td></tr>
    268. 

  268.   </table>
    269. 

  269.   </dd>
    270. 

  270. </dl>
    271. 

  271. <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>
    272. 

  272. 

  273. </div>
    274. 

  274. </div>
    275. 

  275. <a class="anchor" id="gaea0eb550be53aaa5221d8c98a2741a0a"></a>
    276. 

  276. <div class="memitem">
    277. 

  277. <div class="memproto">
    278. 

  278.       <table class="memname">
    279. 

  279.         <tr>
    280. 

  280.           <td class="memname">string findFirstFile </td>
    281. 

  281.           <td>(</td>
    282. 

  282.           <td class="paramtype">strPattern&#160;</td>
    283. 

  283.           <td class="paramname"></td><td>)</td>
    284. 

  284.           <td></td>
    285. 

  285.         </tr>
    286. 

  286.       </table>
    287. 

  287. </div><div class="memdoc">
    288. 

  288. <dl class="params"><dt>Parameters</dt><dd>
    289. 

  289.   <table class="params">
    290. 

  290.     <tr><td class="paramname">strPattern</td><td>The string pattern to search for. </td></tr>
    291. 

  291.   </table>
    292. 

  292.   </dd>
    293. 

  293. </dl>
    294. 

  294. <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>
    295. 

  295. 

  296. </div>
    297. 

  297. </div>
    298. 

  298. <a class="anchor" id="ga8cd2ff98f8ba27b58930d2cef8081d72"></a>
    299. 

  299. <div class="memitem">
    300. 

  300. <div class="memproto">
    301. 

  301.       <table class="memname">
    302. 

  302.         <tr>
    303. 

  303.           <td class="memname">string findFirstFileMultiExpr </td>
    304. 

  304.           <td>(</td>
    305. 

  305.           <td class="paramtype">strPattern&#160;</td>
    306. 

  306.           <td class="paramname"></td><td>)</td>
    307. 

  307.           <td></td>
    308. 

  308.         </tr>
    309. 

  309.       </table>
    310. 

  310. </div><div class="memdoc">
    311. 

  311. <dl class="params"><dt>Parameters</dt><dd>
    312. 

  312.   <table class="params">
    313. 

  313.     <tr><td class="paramname">strPattern</td><td>The string pattern to search for. </td></tr>
    314. 

  314.   </table>
    315. 

  315.   </dd>
    316. 

  316. </dl>
    317. 

  317. <dl class="section return"><dt>Returns</dt><dd>Returns the first file in the directory system matching the given pattern. </dd></dl>
    318. 

  318. 

  319. </div>
    320. 

  320. </div>
    321. 

  321. <a class="anchor" id="gaf136d731a683082f27c2e98121f95ff2"></a>
    322. 

  322. <div class="memitem">
    323. 

  323. <div class="memproto">
    324. 

  324.       <table class="memname">
    325. 

  325.         <tr>
    326. 

  326.           <td class="memname">string findNextFile </td>
    327. 

  327.           <td>(</td>
    328. 

  328.           <td class="paramtype">strPattern&#160;</td>
    329. 

  329.           <td class="paramname"></td><td>)</td>
    330. 

  330.           <td></td>
    331. 

  331.         </tr>
    332. 

  332.       </table>
    333. 

  333. </div><div class="memdoc">
    334. 

  334. <dl class="params"><dt>Parameters</dt><dd>
    335. 

  335.   <table class="params">
    336. 

  336.     <tr><td class="paramname">strPattern</td><td>The string pattern to search for. </td></tr>
    337. 

  337.   </table>
    338. 

  338.   </dd>
    339. 

  339. </dl>
    340. 

  340. <dl class="section return"><dt>Returns</dt><dd>Returns the next file matching a search begun in findFirstFile. </dd></dl>
    341. 

  341. 

  342. </div>
    343. 

  343. </div>
    344. 

  344. <a class="anchor" id="ga06e175fb0e1932859f29eb458b4b632a"></a>
    345. 

  345. <div class="memitem">
    346. 

  346. <div class="memproto">
    347. 

  347.       <table class="memname">
    348. 

  348.         <tr>
    349. 

  349.           <td class="memname">string findNextFileMultiExpr </td>
    350. 

  350.           <td>(</td>
    351. 

  351.           <td class="paramtype">string&#160;</td>
    352. 

  352.           <td class="paramname"><em>pattern</em></td><td>)</td>
    353. 

  353.           <td></td>
    354. 

  354.         </tr>
    355. 

  355.       </table>
    356. 

  356. </div><div class="memdoc">
    357. 

  357. <p>Returns the next file matching a search begun in findFirstFile. </p>
    358. 

  358. 

  359. </div>
    360. 

  360. </div>
    361. 

  361. <a class="anchor" id="ga2efc72629885e6781e39cfb2c8858fc5"></a>
    362. 

  362. <div class="memitem">
    363. 

  363. <div class="memproto">
    364. 

  364.       <table class="memname">
    365. 

  365.         <tr>
    366. 

  366.           <td class="memname">string getCurrentDate </td>
    367. 

  367.           <td>(</td>
    368. 

  368.           <td class="paramtype">bool&#160;</td>
    369. 

  369.           <td class="paramname"><em>reverse</em></td><td>)</td>
    370. 

  370.           <td></td>
    371. 

  371.         </tr>
    372. 

  372.       </table>
    373. 

  373. </div><div class="memdoc">
    374. 

  374. <p>Gets the current date and time. </p>
    375. 

  375. <dl class="params"><dt>Parameters</dt><dd>
    376. 

  376.   <table class="params">
    377. 

  377.     <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>
    378. 

  378.   </table>
    379. 

  379.   </dd>
    380. 

  380. </dl>
    381. 

  381. 

  382. </div>
    383. 

  383. </div>
    384. 

  384. <a class="anchor" id="gaac6cdd11eb85de72f0646f27da108152"></a>
    385. 

  385. <div class="memitem">
    386. 

  386. <div class="memproto">
    387. 

  387.       <table class="memname">
    388. 

  388.         <tr>
    389. 

  389.           <td class="memname">string getCurrentDirectory </td>
    390. 

  390.           <td>(</td>
    391. 

  391.           <td class="paramname"></td><td>)</td>
    392. 

  392.           <td></td>
    393. 

  393.         </tr>
    394. 

  394.       </table>
    395. 

  395. </div><div class="memdoc">
    396. 

  396. 

  397. </div>
    398. 

  398. </div>
    399. 

  399. <a class="anchor" id="ga7e6bb9bd8782ec0d3387a0df8e25f3c5"></a>
    400. 

  400. <div class="memitem">
    401. 

  401. <div class="memproto">
    402. 

  402.       <table class="memname">
    403. 

  403.         <tr>
    404. 

  404.           <td class="memname">string getDirectoryList </td>
    405. 

  405.           <td>(</td>
    406. 

  406.           <td class="paramtype">strPath&#160;</td>
    407. 

  407.           <td class="paramname">, </td>
    408. 

  408.         </tr>
    409. 

  409.         <tr>
    410. 

  410.           <td class="paramkey"></td>
    411. 

  411.           <td></td>
    412. 

  412.           <td class="paramtype">[intDepth] ?&#160;</td>
    413. 

  413.           <td class="paramname">&#160;</td>
    414. 

  414.         </tr>
    415. 

  415.         <tr>
    416. 

  416.           <td></td>
    417. 

  417.           <td>)</td>
    418. 

  418.           <td></td><td></td>
    419. 

  419.         </tr>
    420. 

  420.       </table>
    421. 

  421. </div><div class="memdoc">
    422. 

  422. <dl class="params"><dt>Parameters</dt><dd>
    423. 

  423.   <table class="params">
    424. 

  424.     <tr><td class="paramname">strPath</td><td>The path in which to check </td></tr>
    425. 

  425.     <tr><td class="paramname">intDepth</td><td>The depth in which to return (default 0 if not specified) </td></tr>
    426. 

  426.   </table>
    427. 

  427.   </dd>
    428. 

  428. </dl>
    429. 

  429. <dl class="section return"><dt>Returns</dt><dd>The directory contents </dd></dl>
    430. 

  430. 

  431. </div>
    432. 

  432. </div>
    433. 

  433. <a class="anchor" id="ga02a24eeb379f1f7715e36c0d03873cfd"></a>
    434. 

  434. <div class="memitem">
    435. 

  435. <div class="memproto">
    436. 

  436.       <table class="memname">
    437. 

  437.         <tr>
    438. 

  438.           <td class="memname">string getExecutableName </td>
    439. 

  439.           <td>(</td>
    440. 

  440.           <td class="paramname"></td><td>)</td>
    441. 

  441.           <td></td>
    442. 

  442.         </tr>
    443. 

  443.       </table>
    444. 

  444. </div><div class="memdoc">
    445. 

  445. 

  446. </div>
    447. 

  447. </div>
    448. 

  448. <a class="anchor" id="ga06b4232795c900585d5e6bc67dbb8c78"></a>
    449. 

  449. <div class="memitem">
    450. 

  450. <div class="memproto">
    451. 

  451.       <table class="memname">
    452. 

  452.         <tr>
    453. 

  453.           <td class="memname">int getFileCount </td>
    454. 

  454.           <td>(</td>
    455. 

  455.           <td class="paramtype">strPattern&#160;</td>
    456. 

  456.           <td class="paramname"></td><td>)</td>
    457. 

  457.           <td></td>
    458. 

  458.         </tr>
    459. 

  459.       </table>
    460. 

  460. </div><div class="memdoc">
    461. 

  461. <dl class="params"><dt>Parameters</dt><dd>
    462. 

  462.   <table class="params">
    463. 

  463.     <tr><td class="paramname">strPattern</td><td>The string pattern to search for. </td></tr>
    464. 

  464.   </table>
    465. 

  465.   </dd>
    466. 

  466. </dl>
    467. 

  467. <dl class="section return"><dt>Returns</dt><dd>Returns the number of files in the directory tree that match the given pattern </dd></dl>
    468. 

  468. 

  469. </div>
    470. 

  470. </div>
    471. 

  471. <a class="anchor" id="ga266f46a6c2adcabfa5612d657d65a471"></a>
    472. 

  472. <div class="memitem">
    473. 

  473. <div class="memproto">
    474. 

  474.       <table class="memname">
    475. 

  475.         <tr>
    476. 

  476.           <td class="memname">int getFileCountMultiExpr </td>
    477. 

  477.           <td>(</td>
    478. 

  478.           <td class="paramtype">strPattern&#160;</td>
    479. 

  479.           <td class="paramname"></td><td>)</td>
    480. 

  480.           <td></td>
    481. 

  481.         </tr>
    482. 

  482.       </table>
    483. 

  483. </div><div class="memdoc">
    484. 

  484. <dl class="params"><dt>Parameters</dt><dd>
    485. 

  485.   <table class="params">
    486. 

  486.     <tr><td class="paramname">strPattern</td><td>The string pattern to search for. </td></tr>
    487. 

  487.   </table>
    488. 

  488.   </dd>
    489. 

  489. </dl>
    490. 

  490. <dl class="section return"><dt>Returns</dt><dd>Returns the number of files in the directory tree that match the given pattern </dd></dl>
    491. 

  491. 

  492. </div>
    493. 

  493. </div>
    494. 

  494. <a class="anchor" id="gac98e36fd3fae75b8fed475fcd2112341"></a>
    495. 

  495. <div class="memitem">
    496. 

  496. <div class="memproto">
    497. 

  497.       <table class="memname">
    498. 

  498.         <tr>
    499. 

  499.           <td class="memname">int getFileCRC </td>
    500. 

  500.           <td>(</td>
    501. 

  501.           <td class="paramtype">filename&#160;</td>
    502. 

  502.           <td class="paramname"></td><td>)</td>
    503. 

  503.           <td></td>
    504. 

  504.         </tr>
    505. 

  505.       </table>
    506. 

  506. </div><div class="memdoc">
    507. 

  507. <dl class="params"><dt>Parameters</dt><dd>
    508. 

  508.   <table class="params">
    509. 

  509.     <tr><td class="paramname">filename</td><td>The string representing the file from which to get the CRC </td></tr>
    510. 

  510.   </table>
    511. 

  511.   </dd>
    512. 

  512. </dl>
    513. 

  513. <dl class="section return"><dt>Returns</dt><dd>An integer </dd></dl>
    514. 

  514. 

  515. </div>
    516. 

  516. </div>
    517. 

  517. <a class="anchor" id="ga5740551dfacc700ddf69c4e2facd36fa"></a>
    518. 

  518. <div class="memitem">
    519. 

  519. <div class="memproto">
    520. 

  520.       <table class="memname">
    521. 

  521.         <tr>
    522. 

  522.           <td class="memname">string getFileList </td>
    523. 

  523.           <td>(</td>
    524. 

  524.           <td class="paramtype">strPath&#160;</td>
    525. 

  525.           <td class="paramname"></td><td>)</td>
    526. 

  526.           <td></td>
    527. 

  527.         </tr>
    528. 

  528.       </table>
    529. 

  529. </div><div class="memdoc">
    530. 

  530. <p>Gets all the files in the specified directory. </p>
    531. 

  531. <dl class="params"><dt>Parameters</dt><dd>
    532. 

  532.   <table class="params">
    533. 

  533.     <tr><td class="paramname">strPath</td><td>The path in which to check </td></tr>
    534. 

  534.   </table>
    535. 

  535.   </dd>
    536. 

  536. </dl>
    537. 

  537. <dl class="section return"><dt>Returns</dt><dd>A list of files in the specified directory. </dd></dl>
    538. 

  538. 

  539. </div>
    540. 

  540. </div>
    541. 

  541. <a class="anchor" id="gaf26b6357b62e4ac827f3b2d6f965fd5b"></a>
    542. 

  542. <div class="memitem">
    543. 

  543. <div class="memproto">
    544. 

  544.       <table class="memname">
    545. 

  545.         <tr>
    546. 

  546.           <td class="memname">string getMainDotCsDir </td>
    547. 

  547.           <td>(</td>
    548. 

  548.           <td class="paramname"></td><td>)</td>
    549. 

  549.           <td></td>
    550. 

  550.         </tr>
    551. 

  551.       </table>
    552. 

  552. </div><div class="memdoc">
    553. 

  553. 

  554. </div>
    555. 

  555. </div>
    556. 

  556. <a class="anchor" id="gabe9b77ec3d047aed53f75598d716f199"></a>
    557. 

  557. <div class="memitem">
    558. 

  558. <div class="memproto">
    559. 

  559.       <table class="memname">
    560. 

  560.         <tr>
    561. 

  561.           <td class="memname">bool isDirectory </td>
    562. 

  562.           <td>(</td>
    563. 

  563.           <td class="paramtype">path&#160;</td>
    564. 

  564.           <td class="paramname"></td><td>)</td>
    565. 

  565.           <td></td>
    566. 

  566.         </tr>
    567. 

  567.       </table>
    568. 

  568. </div><div class="memdoc">
    569. 

  569. <dl class="params"><dt>Parameters</dt><dd>
    570. 

  570.   <table class="params">
    571. 

  571.     <tr><td class="paramname">pathName</td><td>Path to check.</td></tr>
    572. 

  572.   </table>
    573. 

  573.   </dd>
    574. 

  574. </dl>
    575. 

  575. <dl class="section return"><dt>Returns</dt><dd>Returns true if the given path is a folder/directory, false otherwise </dd></dl>
    576. 

  576. 

  577. </div>
    578. 

  578. </div>
    579. 

  579. <a class="anchor" id="ga47652fce24570ea88dbe4b872a68f053"></a>
    580. 

  580. <div class="memitem">
    581. 

  581. <div class="memproto">
    582. 

  582.       <table class="memname">
    583. 

  583.         <tr>
    584. 

  584.           <td class="memname">bool isFile </td>
    585. 

  585.           <td>(</td>
    586. 

  586.           <td class="paramtype"><a class="el" href="group__FileSystemFunctions.html#ga71bebb057a0d6ad1c522cd19584b51d9">fileName</a>&#160;</td>
    587. 

  587.           <td class="paramname"></td><td>)</td>
    588. 

  588.           <td></td>
    589. 

  589.         </tr>
    590. 

  590.       </table>
    591. 

  591. </div><div class="memdoc">
    592. 

  592. <dl class="params"><dt>Parameters</dt><dd>
    593. 

  593.   <table class="params">
    594. 

  594.     <tr><td class="paramname">fileName</td><td>Filename to check. </td></tr>
    595. 

  595.   </table>
    596. 

  596.   </dd>
    597. 

  597. </dl>
    598. 

  598. <dl class="section return"><dt>Returns</dt><dd>Returns true if the given filename is an existing file or false otherwise </dd></dl>
    599. 

  599. 

  600. </div>
    601. 

  601. </div>
    602. 

  602. <a class="anchor" id="ga4bf17c60cfe8af8760b494bb29549df4"></a>
    603. 

  603. <div class="memitem">
    604. 

  604. <div class="memproto">
    605. 

  605.       <table class="memname">
    606. 

  606.         <tr>
    607. 

  607.           <td class="memname">bool isValidImageFile </td>
    608. 

  608.           <td>(</td>
    609. 

  609.           <td class="paramtype">string&#160;</td>
    610. 

  610.           <td class="paramname"><em>filePath</em></td><td>)</td>
    611. 

  611.           <td></td>
    612. 

  612.         </tr>
    613. 

  613.       </table>
    614. 

  614. </div><div class="memdoc">
    615. 

  615. <dl class="params"><dt>Parameters</dt><dd>
    616. 

  616.   <table class="params">
    617. 

  617.     <tr><td class="paramname">filePath</td><td>Full path of file to check. </td></tr>
    618. 

  618.   </table>
    619. 

  619.   </dd>
    620. 

  620. </dl>
    621. 

  621. <dl class="section return"><dt>Returns</dt><dd>Returns true if the given filename is a valid image file or false otherwise </dd></dl>
    622. 

  622. 

  623. </div>
    624. 

  624. </div>
    625. 

  625. <a class="anchor" id="ga3e65bc874f8c642d86dcbf483c0306d6"></a>
    626. 

  626. <div class="memitem">
    627. 

  627. <div class="memproto">
    628. 

  628.       <table class="memname">
    629. 

  629.         <tr>
    630. 

  630.           <td class="memname">bool isWriteableFileName </td>
    631. 

  631.           <td>(</td>
    632. 

  632.           <td class="paramtype"><a class="el" href="group__FileSystemFunctions.html#ga71bebb057a0d6ad1c522cd19584b51d9">fileName</a>&#160;</td>
    633. 

  633.           <td class="paramname"></td><td>)</td>
    634. 

  634.           <td></td>
    635. 

  635.         </tr>
    636. 

  636.       </table>
    637. 

  637. </div><div class="memdoc">
    638. 

  638. <dl class="params"><dt>Parameters</dt><dd>
    639. 

  639.   <table class="params">
    640. 

  640.     <tr><td class="paramname">fileName</td><td>Filename to check. </td></tr>
    641. 

  641.   </table>
    642. 

  642.   </dd>
    643. 

  643. </dl>
    644. 

  644. <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>
    645. 

  645. 

  646. </div>
    647. 

  647. </div>
    648. 

  648. <a class="anchor" id="ga678fdc03f838da1f06b86049dc68d1ef"></a>
    649. 

  649. <div class="memitem">
    650. 

  650. <div class="memproto">
    651. 

  651.       <table class="memname">
    652. 

  652.         <tr>
    653. 

  653.           <td class="memname">string makeFullPath </td>
    654. 

  654.           <td>(</td>
    655. 

  655.           <td class="paramtype">string&#160;</td>
    656. 

  656.           <td class="paramname"><em>path</em>, </td>
    657. 

  657.         </tr>
    658. 

  658.         <tr>
    659. 

  659.           <td class="paramkey"></td>
    660. 

  660.           <td></td>
    661. 

  661.           <td class="paramtype">[string currentWorkingDir] ?&#160;</td>
    662. 

  662.           <td class="paramname">&#160;</td>
    663. 

  663.         </tr>
    664. 

  664.         <tr>
    665. 

  665.           <td></td>
    666. 

  666.           <td>)</td>
    667. 

  667.           <td></td><td></td>
    668. 

  668.         </tr>
    669. 

  669.       </table>
    670. 

  670. </div><div class="memdoc">
    671. 

  671. 

  672. </div>
    673. 

  673. </div>
    674. 

  674. <a class="anchor" id="gacdc18653fe1309da7b14f1c23447f68b"></a>
    675. 

  675. <div class="memitem">
    676. 

  676. <div class="memproto">
    677. 

  677.       <table class="memname">
    678. 

  678.         <tr>
    679. 

  679.           <td class="memname">string makeRelativePath </td>
    680. 

  680.           <td>(</td>
    681. 

  681.           <td class="paramtype">string&#160;</td>
    682. 

  682.           <td class="paramname"><em>path</em>, </td>
    683. 

  683.         </tr>
    684. 

  684.         <tr>
    685. 

  685.           <td class="paramkey"></td>
    686. 

  686.           <td></td>
    687. 

  687.           <td class="paramtype">string&#160;</td>
    688. 

  688.           <td class="paramname"><em>to</em>&#160;</td>
    689. 

  689.         </tr>
    690. 

  690.         <tr>
    691. 

  691.           <td></td>
    692. 

  692.           <td>)</td>
    693. 

  693.           <td></td><td></td>
    694. 

  694.         </tr>
    695. 

  695.       </table>
    696. 

  696. </div><div class="memdoc">
    697. 

  697. 

  698. </div>
    699. 

  699. </div>
    700. 

  700. <a class="anchor" id="ga6ed8d04b39e458d9c96572a615c10c34"></a>
    701. 

  701. <div class="memitem">
    702. 

  702. <div class="memproto">
    703. 

  703.       <table class="memname">
    704. 

  704.         <tr>
    705. 

  705.           <td class="memname">void openFolder </td>
    706. 

  706.           <td>(</td>
    707. 

  707.           <td class="paramtype">path&#160;</td>
    708. 

  708.           <td class="paramname"></td><td>)</td>
    709. 

  709.           <td></td>
    710. 

  710.         </tr>
    711. 

  711.       </table>
    712. 

  712. </div><div class="memdoc">
    713. 

  713. <p>; </p>
    714. 

  714. 

  715. </div>
    716. 

  716. </div>
    717. 

  717. <a class="anchor" id="ga81b7e2b1be499d11cea942048ad0bb15"></a>
    718. 

  718. <div class="memitem">
    719. 

  719. <div class="memproto">
    720. 

  720.       <table class="memname">
    721. 

  721.         <tr>
    722. 

  722.           <td class="memname">string pathConcat </td>
    723. 

  723.           <td>(</td>
    724. 

  724.           <td class="paramtype">string&#160;</td>
    725. 

  725.           <td class="paramname"><em>path</em>, </td>
    726. 

  726.         </tr>
    727. 

  727.         <tr>
    728. 

  728.           <td class="paramkey"></td>
    729. 

  729.           <td></td>
    730. 

  730.           <td class="paramtype">string&#160;</td>
    731. 

  731.           <td class="paramname"><em>file1</em>, </td>
    732. 

  732.         </tr>
    733. 

  733.         <tr>
    734. 

  734.           <td class="paramkey"></td>
    735. 

  735.           <td></td>
    736. 

  736.           <td class="paramtype">[... fileN] *&#160;</td>
    737. 

  737.           <td class="paramname">&#160;</td>
    738. 

  738.         </tr>
    739. 

  739.         <tr>
    740. 

  740.           <td></td>
    741. 

  741.           <td>)</td>
    742. 

  742.           <td></td><td></td>
    743. 

  743.         </tr>
    744. 

  744.       </table>
    745. 

  745. </div><div class="memdoc">
    746. 

  746. 

  747. </div>
    748. 

  748. </div>
    749. 

  749. <a class="anchor" id="ga3b01e397c1b597da0ac57f5dcc258d1c"></a>
    750. 

  750. <div class="memitem">
    751. 

  751. <div class="memproto">
    752. 

  752.       <table class="memname">
    753. 

  753.         <tr>
    754. 

  754.           <td class="memname">bool pathCopy </td>
    755. 

  755.           <td>(</td>
    756. 

  756.           <td class="paramtype">fromFile&#160;</td>
    757. 

  757.           <td class="paramname">, </td>
    758. 

  758.         </tr>
    759. 

  759.         <tr>
    760. 

  760.           <td class="paramkey"></td>
    761. 

  761.           <td></td>
    762. 

  762.           <td class="paramtype">toFile&#160;</td>
    763. 

  763.           <td class="paramname">, </td>
    764. 

  764.         </tr>
    765. 

  765.         <tr>
    766. 

  766.           <td class="paramkey"></td>
    767. 

  767.           <td></td>
    768. 

  768.           <td class="paramtype">[nooverwrite = true] ?&#160;</td>
    769. 

  769.           <td class="paramname">&#160;</td>
    770. 

  770.         </tr>
    771. 

  771.         <tr>
    772. 

  772.           <td></td>
    773. 

  773.           <td>)</td>
    774. 

  774.           <td></td><td></td>
    775. 

  775.         </tr>
    776. 

  776.       </table>
    777. 

  777. </div><div class="memdoc">
    778. 

  778. 

  779. </div>
    780. 

  780. </div>
    781. 

  781. <a class="anchor" id="ga55cac30dc1287e0d4ed638af5797c9e8"></a>
    782. 

  782. <div class="memitem">
    783. 

  783. <div class="memproto">
    784. 

  784.       <table class="memname">
    785. 

  785.         <tr>
    786. 

  786.           <td class="memname">void restartInstance </td>
    787. 

  787.           <td>(</td>
    788. 

  788.           <td class="paramname"></td><td>)</td>
    789. 

  789.           <td></td>
    790. 

  790.         </tr>
    791. 

  791.       </table>
    792. 

  792. </div><div class="memdoc">
    793. 

  793. 

  794. </div>
    795. 

  795. </div>
    796. 

  796. <a class="anchor" id="ga72da6dda87dc9fd1c4e6b4d61a682602"></a>
    797. 

  797. <div class="memitem">
    798. 

  798. <div class="memproto">
    799. 

  799.       <table class="memname">
    800. 

  800.         <tr>
    801. 

  801.           <td class="memname">bool setCurrentDirectory </td>
    802. 

  802.           <td>(</td>
    803. 

  803.           <td class="paramtype">absolutePathName&#160;</td>
    804. 

  804.           <td class="paramname"></td><td>)</td>
    805. 

  805.           <td></td>
    806. 

  806.         </tr>
    807. 

  807.       </table>
    808. 

  808. </div><div class="memdoc">
    809. 

  809. 

  810. </div>
    811. 

  811. </div>
    812. 

  812. </div><!-- contents -->
    813. 

  813. <!-- start footer part -->
    814. 

  814. <hr class="footer"/><address class="footer"><small>
    815. 

  815. Generated by &#160;<a href="http://www.doxygen.org/index.html">
    816. 

  816. <img class="footer" src="doxygen.png" alt="doxygen"/>
    817. 

  817. </a> 1.8.3.1
    818. 

  818. </small></address>
    819. 

  819. </body>
    820. 

  820. </html>
    821.