html/doxygen/4.2.0/namespacesago.html
browsing at commit = d359b8303bf7f48a83daa2ba60ccf4414cdc0d9b
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Platform folders: sago Namespace Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Platform folders
 <span id="projectnumber">4.2.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">sago Namespace Reference</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:a85c382a039426b76aa408961ac2149ee"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacesago.html#a85c382a039426b76aa408961ac2149ee">getDataHome</a> ()</td></tr>
<tr class="separator:a85c382a039426b76aa408961ac2149ee"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa6c6da4e6fe460076ac069e176622f59"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacesago.html#aa6c6da4e6fe460076ac069e176622f59">getConfigHome</a> ()</td></tr>
<tr class="separator:aa6c6da4e6fe460076ac069e176622f59"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a426458c0e30383f23ecab17bdf55a407"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacesago.html#a426458c0e30383f23ecab17bdf55a407">getCacheDir</a> ()</td></tr>
<tr class="separator:a426458c0e30383f23ecab17bdf55a407"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8ffd6a057a03d7bd41932bf3fed69874"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacesago.html#a8ffd6a057a03d7bd41932bf3fed69874">getStateDir</a> ()</td></tr>
<tr class="separator:a8ffd6a057a03d7bd41932bf3fed69874"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2d3b0d91188997c4949f5f39a24dd8ab"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacesago.html#a2d3b0d91188997c4949f5f39a24dd8ab">appendAdditionalDataDirectories</a> (std::vector< std::string > &homes)</td></tr>
<tr class="separator:a2d3b0d91188997c4949f5f39a24dd8ab"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a760a4d546d0bccc82dc939ed6e10304d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacesago.html#a760a4d546d0bccc82dc939ed6e10304d">appendAdditionalConfigDirectories</a> (std::vector< std::string > &homes)</td></tr>
<tr class="separator:a760a4d546d0bccc82dc939ed6e10304d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac9fc8e0a8f97b7066548223d43720ce8"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacesago.html#ac9fc8e0a8f97b7066548223d43720ce8">getDesktopFolder</a> ()</td></tr>
<tr class="separator:ac9fc8e0a8f97b7066548223d43720ce8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa44dc2057a9acdb38a10e41a60b7bb82"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacesago.html#aa44dc2057a9acdb38a10e41a60b7bb82">getDocumentsFolder</a> ()</td></tr>
<tr class="separator:aa44dc2057a9acdb38a10e41a60b7bb82"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a650b888f2d54cadfbe3347f3c9c40059"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacesago.html#a650b888f2d54cadfbe3347f3c9c40059">getDownloadFolder</a> ()</td></tr>
<tr class="separator:a650b888f2d54cadfbe3347f3c9c40059"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a853ba2c62cd283e5b8836e9aa98610f3"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacesago.html#a853ba2c62cd283e5b8836e9aa98610f3">getDownloadFolder1</a> ()</td></tr>
<tr class="separator:a853ba2c62cd283e5b8836e9aa98610f3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a45b407f0581bf3ac349682eb2481c630"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacesago.html#a45b407f0581bf3ac349682eb2481c630">getPicturesFolder</a> ()</td></tr>
<tr class="separator:a45b407f0581bf3ac349682eb2481c630"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4c436b1cbbdc85b012877bc80e769dbc"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacesago.html#a4c436b1cbbdc85b012877bc80e769dbc">getPublicFolder</a> ()</td></tr>
<tr class="separator:a4c436b1cbbdc85b012877bc80e769dbc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aef0ecc52b536a96e2f3096b43acbfcbe"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacesago.html#aef0ecc52b536a96e2f3096b43acbfcbe">getMusicFolder</a> ()</td></tr>
<tr class="separator:aef0ecc52b536a96e2f3096b43acbfcbe"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8eda16d34cba4c0f82a6e80077660780"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacesago.html#a8eda16d34cba4c0f82a6e80077660780">getVideoFolder</a> ()</td></tr>
<tr class="separator:a8eda16d34cba4c0f82a6e80077660780"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab568df2aa5ea8492975bbefb206a6145"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacesago.html#ab568df2aa5ea8492975bbefb206a6145">getSaveGamesFolder1</a> ()</td></tr>
<tr class="separator:ab568df2aa5ea8492975bbefb206a6145"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afc7986187926c19b217427a73bdae16e"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacesago.html#afc7986187926c19b217427a73bdae16e">getSaveGamesFolder2</a> ()</td></tr>
<tr class="separator:afc7986187926c19b217427a73bdae16e"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The namespace I use for common function. Nothing special about it. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a760a4d546d0bccc82dc939ed6e10304d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a760a4d546d0bccc82dc939ed6e10304d">◆ </a></span>appendAdditionalConfigDirectories()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sago::appendAdditionalConfigDirectories </td>
<td>(</td>
<td class="paramtype">std::vector< std::string > & </td>
<td class="paramname"><em>homes</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This will append extra folders that your program should be looking for config files in. This does not normally include the path returned by GetConfigHome(). If you want all the folders you should do something like: </p><div class="fragment"><div class="line">std::vector<std::string> folders;</div>
<div class="line">folders.push_back(<a class="code" href="namespacesago.html#aa6c6da4e6fe460076ac069e176622f59">sago::getConfigHome</a>());</div>
<div class="line"><a class="code" href="namespacesago.html#a760a4d546d0bccc82dc939ed6e10304d">sago::appendAdditionalConfigDirectories</a>(folders);</div>
<div class="line"><span class="keywordflow">for</span> (std::string s& : folders) {</div>
<div class="line"> s+=<span class="stringliteral">"/My Program Name/"</span>;</div>
<div class="line">}</div>
<div class="ttc" id="anamespacesago_html_a760a4d546d0bccc82dc939ed6e10304d"><div class="ttname"><a href="namespacesago.html#a760a4d546d0bccc82dc939ed6e10304d">sago::appendAdditionalConfigDirectories</a></div><div class="ttdeci">void appendAdditionalConfigDirectories(std::vector< std::string > &homes)</div></div>
<div class="ttc" id="anamespacesago_html_aa6c6da4e6fe460076ac069e176622f59"><div class="ttname"><a href="namespacesago.html#aa6c6da4e6fe460076ac069e176622f59">sago::getConfigHome</a></div><div class="ttdeci">std::string getConfigHome()</div></div>
</div><!-- fragment --><p> You must apply "/My Program Name/" to all the strings. The string at the lowest index has the highest priority. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">homes</td><td>A vector that extra folders will be appended to. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a2d3b0d91188997c4949f5f39a24dd8ab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2d3b0d91188997c4949f5f39a24dd8ab">◆ </a></span>appendAdditionalDataDirectories()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sago::appendAdditionalDataDirectories </td>
<td>(</td>
<td class="paramtype">std::vector< std::string > & </td>
<td class="paramname"><em>homes</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This will append extra folders that your program should be looking for data files in. This does not normally include the path returned by GetDataHome(). If you want all the folders you should do something like: </p><div class="fragment"><div class="line">vector<string> folders;</div>
<div class="line">folders.push_back(<a class="code" href="namespacesago.html#a85c382a039426b76aa408961ac2149ee">getDataHome</a>());</div>
<div class="line"><a class="code" href="namespacesago.html#a2d3b0d91188997c4949f5f39a24dd8ab">appendAdditionalDataDirectories</a>(folders);</div>
<div class="line"><span class="keywordflow">for</span> (<span class="keywordtype">string</span> s& : folders) {</div>
<div class="line"> s+=<span class="stringliteral">"/My Program Name/"</span>;</div>
<div class="line">}</div>
<div class="ttc" id="anamespacesago_html_a2d3b0d91188997c4949f5f39a24dd8ab"><div class="ttname"><a href="namespacesago.html#a2d3b0d91188997c4949f5f39a24dd8ab">sago::appendAdditionalDataDirectories</a></div><div class="ttdeci">void appendAdditionalDataDirectories(std::vector< std::string > &homes)</div></div>
<div class="ttc" id="anamespacesago_html_a85c382a039426b76aa408961ac2149ee"><div class="ttname"><a href="namespacesago.html#a85c382a039426b76aa408961ac2149ee">sago::getDataHome</a></div><div class="ttdeci">std::string getDataHome()</div></div>
</div><!-- fragment --><p> You must apply "/My Program Name/" to all the strings. The string at the lowest index has the highest priority. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">homes</td><td>A vector that extra folders will be appended to. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a426458c0e30383f23ecab17bdf55a407"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a426458c0e30383f23ecab17bdf55a407">◆ </a></span>getCacheDir()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string sago::getCacheDir </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrives the base folder for storing cache files. You must add the program name yourself like this: </p><div class="fragment"><div class="line"><span class="keywordtype">string</span> data_home = <a class="code" href="namespacesago.html#a426458c0e30383f23ecab17bdf55a407">getCacheDir</a>()+<span class="stringliteral">"/My Program Name/cache/"</span>;</div>
<div class="ttc" id="anamespacesago_html_a426458c0e30383f23ecab17bdf55a407"><div class="ttname"><a href="namespacesago.html#a426458c0e30383f23ecab17bdf55a407">sago::getCacheDir</a></div><div class="ttdeci">std::string getCacheDir()</div></div>
</div><!-- fragment --><p> On Windows this defaults to APPDATALOCAL% On Linux this defaults to ~/.cache but can be configured by the user Note that it is recommended to append "cache" after the program name to prevent conflicting with "StateDir" under Windows </p><dl class="section return"><dt>Returns</dt><dd>The base folder for storing data that do not need to be backed up and might be deleted. </dd></dl>
</div>
</div>
<a id="aa6c6da4e6fe460076ac069e176622f59"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa6c6da4e6fe460076ac069e176622f59">◆ </a></span>getConfigHome()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string sago::getConfigHome </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrives the base folder for storing config files. You must add the program name yourself like this: </p><div class="fragment"><div class="line"><span class="keywordtype">string</span> data_home = <a class="code" href="namespacesago.html#aa6c6da4e6fe460076ac069e176622f59">getConfigHome</a>()+<span class="stringliteral">"/My Program Name/"</span>;</div>
</div><!-- fragment --><p> On Windows this defaults to APPDATA% (Roaming profile) On Linux this defaults to ~/.config but can be configured by the user </p><dl class="section return"><dt>Returns</dt><dd>The base folder for storing config data. </dd></dl>
</div>
</div>
<a id="a85c382a039426b76aa408961ac2149ee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a85c382a039426b76aa408961ac2149ee">◆ </a></span>getDataHome()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string sago::getDataHome </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrives the base folder for storing data files. You must add the program name yourself like this: </p><div class="fragment"><div class="line"><span class="keywordtype">string</span> data_home = <a class="code" href="namespacesago.html#a85c382a039426b76aa408961ac2149ee">getDataHome</a>()+<span class="stringliteral">"/My Program Name/"</span>;</div>
</div><!-- fragment --><p> On Windows this defaults to APPDATA% (Roaming profile) On Linux this defaults to ~/.local/share but can be configured by the user </p><dl class="section return"><dt>Returns</dt><dd>The base folder for storing program data. </dd></dl>
</div>
</div>
<a id="ac9fc8e0a8f97b7066548223d43720ce8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac9fc8e0a8f97b7066548223d43720ce8">◆ </a></span>getDesktopFolder()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string sago::getDesktopFolder </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<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>
</div>
</div>
<a id="aa44dc2057a9acdb38a10e41a60b7bb82"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa44dc2057a9acdb38a10e41a60b7bb82">◆ </a></span>getDocumentsFolder()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string sago::getDocumentsFolder </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<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>
</div>
</div>
<a id="a650b888f2d54cadfbe3347f3c9c40059"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a650b888f2d54cadfbe3347f3c9c40059">◆ </a></span>getDownloadFolder()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string sago::getDownloadFolder </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>The folder where files are downloaded. </p><dl class="section return"><dt>Returns</dt><dd>Absolute path to the folder where files are downloaded to. </dd></dl>
</div>
</div>
<a id="a853ba2c62cd283e5b8836e9aa98610f3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a853ba2c62cd283e5b8836e9aa98610f3">◆ </a></span>getDownloadFolder1()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string sago::getDownloadFolder1 </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>The folder where files are downloaded. </p><dl class="section note"><dt>Note</dt><dd>This is provided for backward compatibility. Use getDownloadFolder instead. </dd></dl>
<dl class="section return"><dt>Returns</dt><dd>Absolute path to the folder where files are downloaded to. </dd></dl>
</div>
</div>
<a id="aef0ecc52b536a96e2f3096b43acbfcbe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aef0ecc52b536a96e2f3096b43acbfcbe">◆ </a></span>getMusicFolder()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string sago::getMusicFolder </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>The folder where music is stored </p><dl class="section return"><dt>Returns</dt><dd>Absolute path to the music folder </dd></dl>
</div>
</div>
<a id="a45b407f0581bf3ac349682eb2481c630"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a45b407f0581bf3ac349682eb2481c630">◆ </a></span>getPicturesFolder()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string sago::getPicturesFolder </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>The folder for storing the user's pictures. </p><dl class="section return"><dt>Returns</dt><dd>Absolute path to the "Picture" folder </dd></dl>
</div>
</div>
<a id="a4c436b1cbbdc85b012877bc80e769dbc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4c436b1cbbdc85b012877bc80e769dbc">◆ </a></span>getPublicFolder()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string sago::getPublicFolder </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This returns the folder that can be used for sharing files with other users on the same system. </p><dl class="section return"><dt>Returns</dt><dd>Absolute path to the "Public" folder </dd></dl>
</div>
</div>
<a id="ab568df2aa5ea8492975bbefb206a6145"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab568df2aa5ea8492975bbefb206a6145">◆ </a></span>getSaveGamesFolder1()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string sago::getSaveGamesFolder1 </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>A base folder for storing saved games. You must add the program name to it like this: </p><div class="fragment"><div class="line"><span class="keywordtype">string</span> saved_games_folder = <a class="code" href="namespacesago.html#ab568df2aa5ea8492975bbefb206a6145">sago::getSaveGamesFolder1</a>()+<span class="stringliteral">"/My Program Name/"</span>;</div>
<div class="ttc" id="anamespacesago_html_ab568df2aa5ea8492975bbefb206a6145"><div class="ttname"><a href="namespacesago.html#ab568df2aa5ea8492975bbefb206a6145">sago::getSaveGamesFolder1</a></div><div class="ttdeci">std::string getSaveGamesFolder1()</div></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>
<dd>
Linux: XDF does not define a folder for saved games. This will just return the same as GetDataHome() </dd></dl>
<dl class="section return"><dt>Returns</dt><dd>The folder base folder for storing save games. </dd></dl>
</div>
</div>
<a id="afc7986187926c19b217427a73bdae16e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afc7986187926c19b217427a73bdae16e">◆ </a></span>getSaveGamesFolder2()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string sago::getSaveGamesFolder2 </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>A base folder for storing saved games. You must add the program name to it like this: </p><div class="fragment"><div class="line"><span class="keywordtype">string</span> saved_games_folder = <a class="code" href="namespacesago.html#afc7986187926c19b217427a73bdae16e">sago::getSaveGamesFolder2</a>()+<span class="stringliteral">"/My Program Name/"</span>;</div>
<div class="ttc" id="anamespacesago_html_afc7986187926c19b217427a73bdae16e"><div class="ttname"><a href="namespacesago.html#afc7986187926c19b217427a73bdae16e">sago::getSaveGamesFolder2</a></div><div class="ttdeci">std::string getSaveGamesFolder2()</div></div>
</div><!-- fragment --> <dl class="section note"><dt>Note</dt><dd>PlatformFolders provide different folders to for saved games as not all operating systems has support for Saved Games yet. It is recommended to pick the highest number (currently getSaveGamesFolder2) at the time your product enters production and stick with it </dd>
<dd>
Windows: This returns the "Saved Games" folder. This folder exist in Vista and later </dd>
<dd>
Linux: XDF does not define a folder for saved games. This will just return the same as GetDataHome() </dd></dl>
<dl class="section return"><dt>Returns</dt><dd>The folder base folder for storing save games. </dd></dl>
</div>
</div>
<a id="a8ffd6a057a03d7bd41932bf3fed69874"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8ffd6a057a03d7bd41932bf3fed69874">◆ </a></span>getStateDir()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string sago::getStateDir </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrives the base folder used for state files. You must add the program name yourself like this: </p><div class="fragment"><div class="line"><span class="keywordtype">string</span> data_home = <a class="code" href="namespacesago.html#a8ffd6a057a03d7bd41932bf3fed69874">getStateDir</a>()+<span class="stringliteral">"/My Program Name/"</span>;</div>
<div class="ttc" id="anamespacesago_html_a8ffd6a057a03d7bd41932bf3fed69874"><div class="ttname"><a href="namespacesago.html#a8ffd6a057a03d7bd41932bf3fed69874">sago::getStateDir</a></div><div class="ttdeci">std::string getStateDir()</div></div>
</div><!-- fragment --><p> On Windows this defaults to APPDATALOCAL% On Linux this defaults to ~/.local/state but can be configured by the user On OS X this is the same as <a class="el" href="namespacesago.html#a85c382a039426b76aa408961ac2149ee">getDataHome()</a> </p><dl class="section return"><dt>Returns</dt><dd>The base folder for storing data that do not need to be backed up but should not be reguarly deleted either. </dd></dl>
</div>
</div>
<a id="a8eda16d34cba4c0f82a6e80077660780"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8eda16d34cba4c0f82a6e80077660780">◆ </a></span>getVideoFolder()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string sago::getVideoFolder </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>The folder where video is stored </p><dl class="section return"><dt>Returns</dt><dd>Absolute path to the video folder </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Feb 6 2022 18:17:54 for Platform folders by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>