group__PlatformFileIOFunctions.html 6.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.3.1"/>
  7. <title>TorqueScript Reference: Platform Filespace</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  12. <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
  13. </head>
  14. <body>
  15. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  16. <div id="titlearea">
  17. <table cellspacing="0" cellpadding="0">
  18. <tbody>
  19. <tr style="height: 56px;">
  20. <td style="padding-left: 0.5em;">
  21. <div id="projectname">TorqueScript Reference
  22. </div>
  23. </td>
  24. </tr>
  25. </tbody>
  26. </table>
  27. </div>
  28. <!-- end header part -->
  29. <!-- Generated by Doxygen 1.8.3.1 -->
  30. <div id="navrow1" class="tabs">
  31. <ul class="tablist">
  32. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  33. <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  34. <li><a href="modules.html"><span>Modules</span></a></li>
  35. <li><a href="annotated.html"><span>Classes</span></a></li>
  36. </ul>
  37. </div>
  38. </div><!-- top -->
  39. <div class="header">
  40. <div class="summary">
  41. <a href="#func-members">Functions</a> </div>
  42. <div class="headertitle">
  43. <div class="title">Platform Filespace<div class="ingroups"><a class="el" href="group__TorqueScriptFunctions.html">Function Categories</a></div></div> </div>
  44. </div><!--header-->
  45. <div class="contents">
  46. <table class="memberdecls">
  47. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  48. Functions</h2></td></tr>
  49. <tr class="memitem:ga58fe9a762c3b8b0bbce9cc9952711230"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PlatformFileIOFunctions.html#ga58fe9a762c3b8b0bbce9cc9952711230">getTemporaryDirectory</a> ()</td></tr>
  50. <tr class="separator:ga58fe9a762c3b8b0bbce9cc9952711230"><td class="memSeparator" colspan="2">&#160;</td></tr>
  51. <tr class="memitem:gaeba6d1178d6ac3447c779e968df3c773"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PlatformFileIOFunctions.html#gaeba6d1178d6ac3447c779e968df3c773">getTemporaryFileName</a> ()</td></tr>
  52. <tr class="separator:gaeba6d1178d6ac3447c779e968df3c773"><td class="memSeparator" colspan="2">&#160;</td></tr>
  53. <tr class="memitem:gad7b9968aa8c151314c514121eb4e4e8d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PlatformFileIOFunctions.html#gad7b9968aa8c151314c514121eb4e4e8d">getUserDataDirectory</a> ()</td></tr>
  54. <tr class="separator:gad7b9968aa8c151314c514121eb4e4e8d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  55. <tr class="memitem:gae3f16f82c521bc566d03409a2a44aaea"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PlatformFileIOFunctions.html#gae3f16f82c521bc566d03409a2a44aaea">getUserHomeDirectory</a> ()</td></tr>
  56. <tr class="separator:gae3f16f82c521bc566d03409a2a44aaea"><td class="memSeparator" colspan="2">&#160;</td></tr>
  57. </table>
  58. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  59. <h2 class="groupheader">Function Documentation</h2>
  60. <a class="anchor" id="ga58fe9a762c3b8b0bbce9cc9952711230"></a>
  61. <div class="memitem">
  62. <div class="memproto">
  63. <table class="memname">
  64. <tr>
  65. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getTemporaryDirectory </td>
  66. <td>(</td>
  67. <td class="paramname"></td><td>)</td>
  68. <td></td>
  69. </tr>
  70. </table>
  71. </div><div class="memdoc">
  72. <p>Gets the path to the system's temporary directory </p>
  73. <dl class="section return"><dt>Returns</dt><dd>Returns the path to the temporary directory as a string </dd></dl>
  74. </div>
  75. </div>
  76. <a class="anchor" id="gaeba6d1178d6ac3447c779e968df3c773"></a>
  77. <div class="memitem">
  78. <div class="memproto">
  79. <table class="memname">
  80. <tr>
  81. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getTemporaryFileName </td>
  82. <td>(</td>
  83. <td class="paramname"></td><td>)</td>
  84. <td></td>
  85. </tr>
  86. </table>
  87. </div><div class="memdoc">
  88. <p>Generates a temporary filename for use. </p>
  89. <dl class="section return"><dt>Returns</dt><dd>Returns the formatted temporary filename for use </dd></dl>
  90. </div>
  91. </div>
  92. <a class="anchor" id="gad7b9968aa8c151314c514121eb4e4e8d"></a>
  93. <div class="memitem">
  94. <div class="memproto">
  95. <table class="memname">
  96. <tr>
  97. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getUserDataDirectory </td>
  98. <td>(</td>
  99. <td class="paramname"></td><td>)</td>
  100. <td></td>
  101. </tr>
  102. </table>
  103. </div><div class="memdoc">
  104. <dl class="section return"><dt>Returns</dt><dd>Returns a string to the directory storing the user's data </dd></dl>
  105. </div>
  106. </div>
  107. <a class="anchor" id="gae3f16f82c521bc566d03409a2a44aaea"></a>
  108. <div class="memitem">
  109. <div class="memproto">
  110. <table class="memname">
  111. <tr>
  112. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getUserHomeDirectory </td>
  113. <td>(</td>
  114. <td class="paramname"></td><td>)</td>
  115. <td></td>
  116. </tr>
  117. </table>
  118. </div><div class="memdoc">
  119. <dl class="section return"><dt>Returns</dt><dd>Returns the path to the user's home directory. </dd></dl>
  120. </div>
  121. </div>
  122. </div><!-- contents -->
  123. <!-- start footer part -->
  124. <hr class="footer"/><address class="footer"><small>
  125. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  126. <img class="footer" src="doxygen.png" alt="doxygen"/>
  127. </a> 1.8.3.1
  128. </small></address>
  129. </body>
  130. </html>