git repos / PlatformFolders

blame: html/doxygen/4.0.0/classsago_1_1PlatformFolders.html

normal view · raw

7e54d64b sago007 2018-06-24 15:21 1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
7e54d64b sago007 2018-06-24 15:21 2
<html xmlns="http://www.w3.org/1999/xhtml">
7e54d64b sago007 2018-06-24 15:21 3
<head>
7e54d64b sago007 2018-06-24 15:21 4
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
7e54d64b sago007 2018-06-24 15:21 5
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
7e54d64b sago007 2018-06-24 15:21 6
<meta name="generator" content="Doxygen 1.8.13"/>
7e54d64b sago007 2018-06-24 15:21 7
<meta name="viewport" content="width=device-width, initial-scale=1"/>
7e54d64b sago007 2018-06-24 15:21 8
<title>Platform folders: sago::PlatformFolders Class Reference</title>
7e54d64b sago007 2018-06-24 15:21 9
<link href="tabs.css" rel="stylesheet" type="text/css"/>
7e54d64b sago007 2018-06-24 15:21 10
<script type="text/javascript" src="jquery.js"></script>
7e54d64b sago007 2018-06-24 15:21 11
<script type="text/javascript" src="dynsections.js"></script>
7e54d64b sago007 2018-06-24 15:21 12
<link href="search/search.css" rel="stylesheet" type="text/css"/>
7e54d64b sago007 2018-06-24 15:21 13
<script type="text/javascript" src="search/searchdata.js"></script>
7e54d64b sago007 2018-06-24 15:21 14
<script type="text/javascript" src="search/search.js"></script>
7e54d64b sago007 2018-06-24 15:21 15
<link href="doxygen.css" rel="stylesheet" type="text/css" />
7e54d64b sago007 2018-06-24 15:21 16
</head>
7e54d64b sago007 2018-06-24 15:21 17
<body>
7e54d64b sago007 2018-06-24 15:21 18
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
7e54d64b sago007 2018-06-24 15:21 19
<div id="titlearea">
7e54d64b sago007 2018-06-24 15:21 20
<table cellspacing="0" cellpadding="0">
7e54d64b sago007 2018-06-24 15:21 21
 <tbody>
7e54d64b sago007 2018-06-24 15:21 22
 <tr style="height: 56px;">
7e54d64b sago007 2018-06-24 15:21 23
  <td id="projectalign" style="padding-left: 0.5em;">
7e54d64b sago007 2018-06-24 15:21 24
   <div id="projectname">Platform folders
7e54d64b sago007 2018-06-24 15:21 25
   &#160;<span id="projectnumber">4.0.0</span>
7e54d64b sago007 2018-06-24 15:21 26
   </div>
7e54d64b sago007 2018-06-24 15:21 27
  </td>
7e54d64b sago007 2018-06-24 15:21 28
 </tr>
7e54d64b sago007 2018-06-24 15:21 29
 </tbody>
7e54d64b sago007 2018-06-24 15:21 30
</table>
7e54d64b sago007 2018-06-24 15:21 31
</div>
7e54d64b sago007 2018-06-24 15:21 32
<!-- end header part -->
7e54d64b sago007 2018-06-24 15:21 33
<!-- Generated by Doxygen 1.8.13 -->
7e54d64b sago007 2018-06-24 15:21 34
<script type="text/javascript">
7e54d64b sago007 2018-06-24 15:21 35
var searchBox = new SearchBox("searchBox", "search",false,'Search');
7e54d64b sago007 2018-06-24 15:21 36
</script>
7e54d64b sago007 2018-06-24 15:21 37
<script type="text/javascript" src="menudata.js"></script>
7e54d64b sago007 2018-06-24 15:21 38
<script type="text/javascript" src="menu.js"></script>
7e54d64b sago007 2018-06-24 15:21 39
<script type="text/javascript">
7e54d64b sago007 2018-06-24 15:21 40
$(function() {
7e54d64b sago007 2018-06-24 15:21 41
  initMenu('',true,false,'search.php','Search');
7e54d64b sago007 2018-06-24 15:21 42
  $(document).ready(function() { init_search(); });
7e54d64b sago007 2018-06-24 15:21 43
});
7e54d64b sago007 2018-06-24 15:21 44
</script>
7e54d64b sago007 2018-06-24 15:21 45
<div id="main-nav"></div>
7e54d64b sago007 2018-06-24 15:21 46
<!-- window showing the filter options -->
7e54d64b sago007 2018-06-24 15:21 47
<div id="MSearchSelectWindow"
7e54d64b sago007 2018-06-24 15:21 48
     onmouseover="return searchBox.OnSearchSelectShow()"
7e54d64b sago007 2018-06-24 15:21 49
     onmouseout="return searchBox.OnSearchSelectHide()"
7e54d64b sago007 2018-06-24 15:21 50
     onkeydown="return searchBox.OnSearchSelectKey(event)">
7e54d64b sago007 2018-06-24 15:21 51
</div>
7e54d64b sago007 2018-06-24 15:21 52
7e54d64b sago007 2018-06-24 15:21 53
<!-- iframe showing the search results (closed by default) -->
7e54d64b sago007 2018-06-24 15:21 54
<div id="MSearchResultsWindow">
7e54d64b sago007 2018-06-24 15:21 55
<iframe src="javascript:void(0)" frameborder="0" 
7e54d64b sago007 2018-06-24 15:21 56
        name="MSearchResults" id="MSearchResults">
7e54d64b sago007 2018-06-24 15:21 57
</iframe>
7e54d64b sago007 2018-06-24 15:21 58
</div>
7e54d64b sago007 2018-06-24 15:21 59
7e54d64b sago007 2018-06-24 15:21 60
<div id="nav-path" class="navpath">
7e54d64b sago007 2018-06-24 15:21 61
  <ul>
7e54d64b sago007 2018-06-24 15:21 62
<li class="navelem"><a class="el" href="namespacesago.html">sago</a></li><li class="navelem"><a class="el" href="classsago_1_1PlatformFolders.html">PlatformFolders</a></li>  </ul>
7e54d64b sago007 2018-06-24 15:21 63
</div>
7e54d64b sago007 2018-06-24 15:21 64
</div><!-- top -->
7e54d64b sago007 2018-06-24 15:21 65
<div class="header">
7e54d64b sago007 2018-06-24 15:21 66
  <div class="summary">
7e54d64b sago007 2018-06-24 15:21 67
<a href="#pub-methods">Public Member Functions</a> &#124;
7e54d64b sago007 2018-06-24 15:21 68
<a href="classsago_1_1PlatformFolders-members.html">List of all members</a>  </div>
7e54d64b sago007 2018-06-24 15:21 69
  <div class="headertitle">
7e54d64b sago007 2018-06-24 15:21 70
<div class="title">sago::PlatformFolders Class Reference</div>  </div>
7e54d64b sago007 2018-06-24 15:21 71
</div><!--header-->
7e54d64b sago007 2018-06-24 15:21 72
<div class="contents">
7e54d64b sago007 2018-06-24 15:21 73
7e54d64b sago007 2018-06-24 15:21 74
<p><code>#include &lt;<a class="el" href="platform__folders_8h_source.html">platform_folders.h</a>&gt;</code></p>
7e54d64b sago007 2018-06-24 15:21 75
<table class="memberdecls">
7e54d64b sago007 2018-06-24 15:21 76
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
7e54d64b sago007 2018-06-24 15:21 77
Public Member Functions</h2></td></tr>
7e54d64b sago007 2018-06-24 15:21 78
<tr class="memitem:a6aca8cb29f7a2c48ca4f99438e3ed175"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsago_1_1PlatformFolders.html#a6aca8cb29f7a2c48ca4f99438e3ed175">getDesktopFolder</a> () const</td></tr>
7e54d64b sago007 2018-06-24 15:21 79
<tr class="separator:a6aca8cb29f7a2c48ca4f99438e3ed175"><td class="memSeparator" colspan="2">&#160;</td></tr>
7e54d64b sago007 2018-06-24 15:21 80
<tr class="memitem:aa4c7f57a44e5cd6849c06ba6cfa5288e"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsago_1_1PlatformFolders.html#aa4c7f57a44e5cd6849c06ba6cfa5288e">getDocumentsFolder</a> () const</td></tr>
7e54d64b sago007 2018-06-24 15:21 81
<tr class="separator:aa4c7f57a44e5cd6849c06ba6cfa5288e"><td class="memSeparator" colspan="2">&#160;</td></tr>
7e54d64b sago007 2018-06-24 15:21 82
<tr class="memitem:a573bcf35075a58e91012d902add73d91"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsago_1_1PlatformFolders.html#a573bcf35075a58e91012d902add73d91">getPicturesFolder</a> () const</td></tr>
7e54d64b sago007 2018-06-24 15:21 83
<tr class="separator:a573bcf35075a58e91012d902add73d91"><td class="memSeparator" colspan="2">&#160;</td></tr>
7e54d64b sago007 2018-06-24 15:21 84
<tr class="memitem:a355f057f49ef1fd0a6b13b8550e7efbe"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsago_1_1PlatformFolders.html#a355f057f49ef1fd0a6b13b8550e7efbe">getPublicFolder</a> () const</td></tr>
7e54d64b sago007 2018-06-24 15:21 85
<tr class="separator:a355f057f49ef1fd0a6b13b8550e7efbe"><td class="memSeparator" colspan="2">&#160;</td></tr>
7e54d64b sago007 2018-06-24 15:21 86
<tr class="memitem:a6142e940eb75c6eb0c13c5bc40401041"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsago_1_1PlatformFolders.html#a6142e940eb75c6eb0c13c5bc40401041">getDownloadFolder1</a> () const</td></tr>
7e54d64b sago007 2018-06-24 15:21 87
<tr class="separator:a6142e940eb75c6eb0c13c5bc40401041"><td class="memSeparator" colspan="2">&#160;</td></tr>
7e54d64b sago007 2018-06-24 15:21 88
<tr class="memitem:a6bb0d7cc44a9f253610aba7af873b68a"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsago_1_1PlatformFolders.html#a6bb0d7cc44a9f253610aba7af873b68a">getMusicFolder</a> () const</td></tr>
7e54d64b sago007 2018-06-24 15:21 89
<tr class="separator:a6bb0d7cc44a9f253610aba7af873b68a"><td class="memSeparator" colspan="2">&#160;</td></tr>
7e54d64b sago007 2018-06-24 15:21 90
<tr class="memitem:a4aee4289ce9dea7a41a00f676dd2d800"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsago_1_1PlatformFolders.html#a4aee4289ce9dea7a41a00f676dd2d800">getVideoFolder</a> () const</td></tr>
7e54d64b sago007 2018-06-24 15:21 91
<tr class="separator:a4aee4289ce9dea7a41a00f676dd2d800"><td class="memSeparator" colspan="2">&#160;</td></tr>
7e54d64b sago007 2018-06-24 15:21 92
<tr class="memitem:ad1d62d1c68c143308f1703d1033265f6"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsago_1_1PlatformFolders.html#ad1d62d1c68c143308f1703d1033265f6">getSaveGamesFolder1</a> () const</td></tr>
7e54d64b sago007 2018-06-24 15:21 93
<tr class="separator:ad1d62d1c68c143308f1703d1033265f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
7e54d64b sago007 2018-06-24 15:21 94
</table>
7e54d64b sago007 2018-06-24 15:21 95
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
7e54d64b sago007 2018-06-24 15:21 96
<div class="textblock"><p>This class contains methods for finding the system depended special folders. For Windows these folders are either by convention or given by CSIDL. For Linux XDG convention is used. The Linux version has very little error checking and assumes that the config is correct </p>
7e54d64b sago007 2018-06-24 15:21 97
</div><h2 class="groupheader">Member Function Documentation</h2>
7e54d64b sago007 2018-06-24 15:21 98
<a id="a6aca8cb29f7a2c48ca4f99438e3ed175"></a>
7e54d64b sago007 2018-06-24 15:21 99
<h2 class="memtitle"><span class="permalink"><a href="#a6aca8cb29f7a2c48ca4f99438e3ed175">&#9670;&nbsp;</a></span>getDesktopFolder()</h2>
7e54d64b sago007 2018-06-24 15:21 100
7e54d64b sago007 2018-06-24 15:21 101
<div class="memitem">
7e54d64b sago007 2018-06-24 15:21 102
<div class="memproto">
7e54d64b sago007 2018-06-24 15:21 103
      <table class="memname">
7e54d64b sago007 2018-06-24 15:21 104
        <tr>
7e54d64b sago007 2018-06-24 15:21 105
          <td class="memname">std::string sago::PlatformFolders::getDesktopFolder </td>
7e54d64b sago007 2018-06-24 15:21 106
          <td>(</td>
7e54d64b sago007 2018-06-24 15:21 107
          <td class="paramname"></td><td>)</td>
7e54d64b sago007 2018-06-24 15:21 108
          <td> const</td>
7e54d64b sago007 2018-06-24 15:21 109
        </tr>
7e54d64b sago007 2018-06-24 15:21 110
      </table>
7e54d64b sago007 2018-06-24 15:21 111
</div><div class="memdoc">
7e54d64b sago007 2018-06-24 15:21 112
<p>The folder that represents the desktop. Normally you should try not to use this folder. </p><dl class="section return"><dt>Returns</dt><dd>Absolute path to the user's desktop </dd></dl>
7e54d64b sago007 2018-06-24 15:21 113
7e54d64b sago007 2018-06-24 15:21 114
</div>
7e54d64b sago007 2018-06-24 15:21 115
</div>
7e54d64b sago007 2018-06-24 15:21 116
<a id="aa4c7f57a44e5cd6849c06ba6cfa5288e"></a>
7e54d64b sago007 2018-06-24 15:21 117
<h2 class="memtitle"><span class="permalink"><a href="#aa4c7f57a44e5cd6849c06ba6cfa5288e">&#9670;&nbsp;</a></span>getDocumentsFolder()</h2>
7e54d64b sago007 2018-06-24 15:21 118
7e54d64b sago007 2018-06-24 15:21 119
<div class="memitem">
7e54d64b sago007 2018-06-24 15:21 120
<div class="memproto">
7e54d64b sago007 2018-06-24 15:21 121
      <table class="memname">
7e54d64b sago007 2018-06-24 15:21 122
        <tr>
7e54d64b sago007 2018-06-24 15:21 123
          <td class="memname">std::string sago::PlatformFolders::getDocumentsFolder </td>
7e54d64b sago007 2018-06-24 15:21 124
          <td>(</td>
7e54d64b sago007 2018-06-24 15:21 125
          <td class="paramname"></td><td>)</td>
7e54d64b sago007 2018-06-24 15:21 126
          <td> const</td>
7e54d64b sago007 2018-06-24 15:21 127
        </tr>
7e54d64b sago007 2018-06-24 15:21 128
      </table>
7e54d64b sago007 2018-06-24 15:21 129
</div><div class="memdoc">
7e54d64b sago007 2018-06-24 15:21 130
<p>The folder to store user documents to </p><dl class="section return"><dt>Returns</dt><dd>Absolute path to the "Documents" folder </dd></dl>
7e54d64b sago007 2018-06-24 15:21 131
7e54d64b sago007 2018-06-24 15:21 132
</div>
7e54d64b sago007 2018-06-24 15:21 133
</div>
7e54d64b sago007 2018-06-24 15:21 134
<a id="a6142e940eb75c6eb0c13c5bc40401041"></a>
7e54d64b sago007 2018-06-24 15:21 135
<h2 class="memtitle"><span class="permalink"><a href="#a6142e940eb75c6eb0c13c5bc40401041">&#9670;&nbsp;</a></span>getDownloadFolder1()</h2>
7e54d64b sago007 2018-06-24 15:21 136
7e54d64b sago007 2018-06-24 15:21 137
<div class="memitem">
7e54d64b sago007 2018-06-24 15:21 138
<div class="memproto">
7e54d64b sago007 2018-06-24 15:21 139
      <table class="memname">
7e54d64b sago007 2018-06-24 15:21 140
        <tr>
7e54d64b sago007 2018-06-24 15:21 141
          <td class="memname">std::string sago::PlatformFolders::getDownloadFolder1 </td>
7e54d64b sago007 2018-06-24 15:21 142
          <td>(</td>
7e54d64b sago007 2018-06-24 15:21 143
          <td class="paramname"></td><td>)</td>
7e54d64b sago007 2018-06-24 15:21 144
          <td> const</td>
7e54d64b sago007 2018-06-24 15:21 145
        </tr>
7e54d64b sago007 2018-06-24 15:21 146
      </table>
7e54d64b sago007 2018-06-24 15:21 147
</div><div class="memdoc">
7e54d64b sago007 2018-06-24 15:21 148
<p>The folder where files are downloaded. </p><dl class="section note"><dt>Note</dt><dd>Windows: This version is XP compatible and returns the Desktop. Vista and later has a dedicated folder. </dd></dl>
7e54d64b sago007 2018-06-24 15:21 149
<dl class="section return"><dt>Returns</dt><dd>Absolute path to the folder where files are downloaded to. </dd></dl>
7e54d64b sago007 2018-06-24 15:21 150
7e54d64b sago007 2018-06-24 15:21 151
</div>
7e54d64b sago007 2018-06-24 15:21 152
</div>
7e54d64b sago007 2018-06-24 15:21 153
<a id="a6bb0d7cc44a9f253610aba7af873b68a"></a>
7e54d64b sago007 2018-06-24 15:21 154
<h2 class="memtitle"><span class="permalink"><a href="#a6bb0d7cc44a9f253610aba7af873b68a">&#9670;&nbsp;</a></span>getMusicFolder()</h2>
7e54d64b sago007 2018-06-24 15:21 155
7e54d64b sago007 2018-06-24 15:21 156
<div class="memitem">
7e54d64b sago007 2018-06-24 15:21 157
<div class="memproto">
7e54d64b sago007 2018-06-24 15:21 158
      <table class="memname">
7e54d64b sago007 2018-06-24 15:21 159
        <tr>
7e54d64b sago007 2018-06-24 15:21 160
          <td class="memname">std::string sago::PlatformFolders::getMusicFolder </td>
7e54d64b sago007 2018-06-24 15:21 161
          <td>(</td>
7e54d64b sago007 2018-06-24 15:21 162
          <td class="paramname"></td><td>)</td>
7e54d64b sago007 2018-06-24 15:21 163
          <td> const</td>
7e54d64b sago007 2018-06-24 15:21 164
        </tr>
7e54d64b sago007 2018-06-24 15:21 165
      </table>
7e54d64b sago007 2018-06-24 15:21 166
</div><div class="memdoc">
7e54d64b sago007 2018-06-24 15:21 167
<p>The folder where music is stored </p><dl class="section return"><dt>Returns</dt><dd>Absolute path to the music folder </dd></dl>
7e54d64b sago007 2018-06-24 15:21 168
7e54d64b sago007 2018-06-24 15:21 169
</div>
7e54d64b sago007 2018-06-24 15:21 170
</div>
7e54d64b sago007 2018-06-24 15:21 171
<a id="a573bcf35075a58e91012d902add73d91"></a>
7e54d64b sago007 2018-06-24 15:21 172
<h2 class="memtitle"><span class="permalink"><a href="#a573bcf35075a58e91012d902add73d91">&#9670;&nbsp;</a></span>getPicturesFolder()</h2>
7e54d64b sago007 2018-06-24 15:21 173
7e54d64b sago007 2018-06-24 15:21 174
<div class="memitem">
7e54d64b sago007 2018-06-24 15:21 175
<div class="memproto">
7e54d64b sago007 2018-06-24 15:21 176
      <table class="memname">
7e54d64b sago007 2018-06-24 15:21 177
        <tr>
7e54d64b sago007 2018-06-24 15:21 178
          <td class="memname">std::string sago::PlatformFolders::getPicturesFolder </td>
7e54d64b sago007 2018-06-24 15:21 179
          <td>(</td>
7e54d64b sago007 2018-06-24 15:21 180
          <td class="paramname"></td><td>)</td>
7e54d64b sago007 2018-06-24 15:21 181
          <td> const</td>
7e54d64b sago007 2018-06-24 15:21 182
        </tr>
7e54d64b sago007 2018-06-24 15:21 183
      </table>
7e54d64b sago007 2018-06-24 15:21 184
</div><div class="memdoc">
7e54d64b sago007 2018-06-24 15:21 185
<p>The folder for storring the user's pictures. </p><dl class="section return"><dt>Returns</dt><dd>Absolute path to the "Picture" folder </dd></dl>
7e54d64b sago007 2018-06-24 15:21 186
7e54d64b sago007 2018-06-24 15:21 187
</div>
7e54d64b sago007 2018-06-24 15:21 188
</div>
7e54d64b sago007 2018-06-24 15:21 189
<a id="a355f057f49ef1fd0a6b13b8550e7efbe"></a>
7e54d64b sago007 2018-06-24 15:21 190
<h2 class="memtitle"><span class="permalink"><a href="#a355f057f49ef1fd0a6b13b8550e7efbe">&#9670;&nbsp;</a></span>getPublicFolder()</h2>
7e54d64b sago007 2018-06-24 15:21 191
7e54d64b sago007 2018-06-24 15:21 192
<div class="memitem">
7e54d64b sago007 2018-06-24 15:21 193
<div class="memproto">
7e54d64b sago007 2018-06-24 15:21 194
      <table class="memname">
7e54d64b sago007 2018-06-24 15:21 195
        <tr>
7e54d64b sago007 2018-06-24 15:21 196
          <td class="memname">std::string sago::PlatformFolders::getPublicFolder </td>
7e54d64b sago007 2018-06-24 15:21 197
          <td>(</td>
7e54d64b sago007 2018-06-24 15:21 198
          <td class="paramname"></td><td>)</td>
7e54d64b sago007 2018-06-24 15:21 199
          <td> const</td>
7e54d64b sago007 2018-06-24 15:21 200
        </tr>
7e54d64b sago007 2018-06-24 15:21 201
      </table>
7e54d64b sago007 2018-06-24 15:21 202
</div><div class="memdoc">
7e54d64b sago007 2018-06-24 15:21 203
<p>Use <a class="el" href="namespacesago.html#a4c436b1cbbdc85b012877bc80e769dbc">sago::getPublicFolder()</a> instead! </p>
7e54d64b sago007 2018-06-24 15:21 204
7e54d64b sago007 2018-06-24 15:21 205
</div>
7e54d64b sago007 2018-06-24 15:21 206
</div>
7e54d64b sago007 2018-06-24 15:21 207
<a id="ad1d62d1c68c143308f1703d1033265f6"></a>
7e54d64b sago007 2018-06-24 15:21 208
<h2 class="memtitle"><span class="permalink"><a href="#ad1d62d1c68c143308f1703d1033265f6">&#9670;&nbsp;</a></span>getSaveGamesFolder1()</h2>
7e54d64b sago007 2018-06-24 15:21 209
7e54d64b sago007 2018-06-24 15:21 210
<div class="memitem">
7e54d64b sago007 2018-06-24 15:21 211
<div class="memproto">
7e54d64b sago007 2018-06-24 15:21 212
      <table class="memname">
7e54d64b sago007 2018-06-24 15:21 213
        <tr>
7e54d64b sago007 2018-06-24 15:21 214
          <td class="memname">std::string sago::PlatformFolders::getSaveGamesFolder1 </td>
7e54d64b sago007 2018-06-24 15:21 215
          <td>(</td>
7e54d64b sago007 2018-06-24 15:21 216
          <td class="paramname"></td><td>)</td>
7e54d64b sago007 2018-06-24 15:21 217
          <td> const</td>
7e54d64b sago007 2018-06-24 15:21 218
        </tr>
7e54d64b sago007 2018-06-24 15:21 219
      </table>
7e54d64b sago007 2018-06-24 15:21 220
</div><div class="memdoc">
7e54d64b sago007 2018-06-24 15:21 221
<p>The base folder for storring saved games. You must add the program name to it like this: </p><div class="fragment"><div class="line">PlatformFolders pf;</div><div class="line"><span class="keywordtype">string</span> saved_games_folder = pf.getSaveGamesFolder1()+<span class="stringliteral">&quot;/My Program Name/&quot;</span>;</div></div><!-- fragment --> <dl class="section note"><dt>Note</dt><dd>Windows: This is an XP compatible version and returns the path to "My Games" in Documents. Vista and later has an official folder. </dd>
7e54d64b sago007 2018-06-24 15:21 222
<dd>
7e54d64b sago007 2018-06-24 15:21 223
Linux: XDF does not define a folder for saved games. This will just return the same as GetDataHome() </dd></dl>
7e54d64b sago007 2018-06-24 15:21 224
<dl class="section return"><dt>Returns</dt><dd>The folder base folder for storring save games. </dd></dl>
7e54d64b sago007 2018-06-24 15:21 225
7e54d64b sago007 2018-06-24 15:21 226
</div>
7e54d64b sago007 2018-06-24 15:21 227
</div>
7e54d64b sago007 2018-06-24 15:21 228
<a id="a4aee4289ce9dea7a41a00f676dd2d800"></a>
7e54d64b sago007 2018-06-24 15:21 229
<h2 class="memtitle"><span class="permalink"><a href="#a4aee4289ce9dea7a41a00f676dd2d800">&#9670;&nbsp;</a></span>getVideoFolder()</h2>
7e54d64b sago007 2018-06-24 15:21 230
7e54d64b sago007 2018-06-24 15:21 231
<div class="memitem">
7e54d64b sago007 2018-06-24 15:21 232
<div class="memproto">
7e54d64b sago007 2018-06-24 15:21 233
      <table class="memname">
7e54d64b sago007 2018-06-24 15:21 234
        <tr>
7e54d64b sago007 2018-06-24 15:21 235
          <td class="memname">std::string sago::PlatformFolders::getVideoFolder </td>
7e54d64b sago007 2018-06-24 15:21 236
          <td>(</td>
7e54d64b sago007 2018-06-24 15:21 237
          <td class="paramname"></td><td>)</td>
7e54d64b sago007 2018-06-24 15:21 238
          <td> const</td>
7e54d64b sago007 2018-06-24 15:21 239
        </tr>
7e54d64b sago007 2018-06-24 15:21 240
      </table>
7e54d64b sago007 2018-06-24 15:21 241
</div><div class="memdoc">
7e54d64b sago007 2018-06-24 15:21 242
<p>The folder where video is stored </p><dl class="section return"><dt>Returns</dt><dd>Absolute path to the video folder </dd></dl>
7e54d64b sago007 2018-06-24 15:21 243
7e54d64b sago007 2018-06-24 15:21 244
</div>
7e54d64b sago007 2018-06-24 15:21 245
</div>
7e54d64b sago007 2018-06-24 15:21 246
<hr/>The documentation for this class was generated from the following file:<ul>
7e54d64b sago007 2018-06-24 15:21 247
<li><a class="el" href="platform__folders_8h_source.html">platform_folders.h</a></li>
7e54d64b sago007 2018-06-24 15:21 248
</ul>
7e54d64b sago007 2018-06-24 15:21 249
</div><!-- contents -->
7e54d64b sago007 2018-06-24 15:21 250
<!-- start footer part -->
7e54d64b sago007 2018-06-24 15:21 251
<hr class="footer"/><address class="footer"><small>
7e54d64b sago007 2018-06-24 15:21 252
Generated on Sun Jun 24 2018 16:38:12 for Platform folders by &#160;<a href="http://www.doxygen.org/index.html">
7e54d64b sago007 2018-06-24 15:21 253
<img class="footer" src="doxygen.png" alt="doxygen"/>
7e54d64b sago007 2018-06-24 15:21 254
</a> 1.8.13
7e54d64b sago007 2018-06-24 15:21 255
</small></address>
7e54d64b sago007 2018-06-24 15:21 256
</body>
7e54d64b sago007 2018-06-24 15:21 257
</html>
1970-01-01 00:00 258