herbglitch/archeus
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
archeus/doc/doxygen/html/d3/d58/std_2config_8h.html

582 lines
34 KiB
HTML
Raw Blame History

<!-- HTML header for doxygen 1.9.2-->
<!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" class="dark-mode">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Archeus: /home/herbglitch/programs/archeus/arc/include/arc/std/config.h File 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="../../navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../navtreedata.js"></script>
<script type="text/javascript" src="../../navtree.js"></script>
<script type="text/javascript" src="../../resize.js"></script>
<script type="text/javascript" src="../../cookie.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" />
<link href="../../doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="../../doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
<link href="../../doxygen-awesome-sidebar-only-darkmode-toggle.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../doxygen-awesome-darkmode-toggle.js"></script>
</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">Archeus<span id="projectnumber">&#160;0.0.0</span>
</div>
<div id="projectbrief">A C library and game engine that focuses on documentation</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "../../search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(1); });
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('../../',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('d3/d58/std_2config_8h.html','../../'); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<!-- 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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">config.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="../../dd/d16/hashtable_8h_source.html">arc/std/hashtable.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="../../da/d66/string_8h_source.html">arc/std/string.h</a>&quot;</code><br />
<code>#include &lt;stdint.h&gt;</code><br />
</div>
<p><a href="../../d3/d58/std_2config_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:aa8d55a1d202b495b292e51919ee099d1" id="r_aa8d55a1d202b495b292e51919ee099d1"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa8d55a1d202b495b292e51919ee099d1">ARC_KEY_BUCKET_SIZE</a>&#160;&#160;&#160;0x20</td></tr>
<tr class="separator:aa8d55a1d202b495b292e51919ee099d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aebe7e30736515ea92af7365a8c05e269" id="r_aebe7e30736515ea92af7365a8c05e269"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aebe7e30736515ea92af7365a8c05e269">ARC_GROUP_BUCKET_SIZE</a>&#160;&#160;&#160;0x20</td></tr>
<tr class="separator:aebe7e30736515ea92af7365a8c05e269"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2979878127e519a90fc5276c19405a55" id="r_a2979878127e519a90fc5276c19405a55"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2979878127e519a90fc5276c19405a55">ARC_GROUP_DATA_BUCKET_SIZE</a>&#160;&#160;&#160;0x20</td></tr>
<tr class="separator:a2979878127e519a90fc5276c19405a55"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a696d760ea66fed20ff42c3aaac0f9609" id="r_a696d760ea66fed20ff42c3aaac0f9609"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a696d760ea66fed20ff42c3aaac0f9609">ARC_CONFIG_FILE_IO_LOAD</a>&#160;&#160;&#160;0x00</td></tr>
<tr class="memdesc:a696d760ea66fed20ff42c3aaac0f9609"><td class="mdescLeft">&#160;</td><td class="mdescRight">commands that can be used in ARC_Config_FileIO <br /></td></tr>
<tr class="separator:a696d760ea66fed20ff42c3aaac0f9609"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a101688a6bcee61c9a68cdc4a9fea8ce6" id="r_a101688a6bcee61c9a68cdc4a9fea8ce6"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a101688a6bcee61c9a68cdc4a9fea8ce6">ARC_CONFIG_FILE_IO_UNLOAD</a>&#160;&#160;&#160;0x01</td></tr>
<tr class="separator:a101688a6bcee61c9a68cdc4a9fea8ce6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a24eb640dcf65c28bc8e07ea59a733245" id="r_a24eb640dcf65c28bc8e07ea59a733245"><td class="memItemLeft" align="right" valign="top">typedef uint8_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a24eb640dcf65c28bc8e07ea59a733245">ARC_ConfigKeyRead</a>) (<a class="el" href="../../df/df7/audio_2config_8h.html#aabee9667260a8e773757a111923b6c60">ARC_Config</a> *config, <a class="el" href="../../df/d06/structARC__String.html">ARC_String</a> *string, void **value)</td></tr>
<tr class="memdesc:a24eb640dcf65c28bc8e07ea59a733245"><td class="mdescLeft">&#160;</td><td class="mdescRight">a function to read a key from string to a ARC_ConfigTypeTemplate <br /></td></tr>
<tr class="separator:a24eb640dcf65c28bc8e07ea59a733245"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af84f4d14d9da265c9f136b832a16bc9c" id="r_af84f4d14d9da265c9f136b832a16bc9c"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af84f4d14d9da265c9f136b832a16bc9c">ARC_ConfigKeyDelete</a>) (<a class="el" href="../../df/df7/audio_2config_8h.html#aabee9667260a8e773757a111923b6c60">ARC_Config</a> *config, <a class="el" href="../../df/d06/structARC__String.html">ARC_String</a> *string, void *value)</td></tr>
<tr class="memdesc:af84f4d14d9da265c9f136b832a16bc9c"><td class="mdescLeft">&#160;</td><td class="mdescRight">a function to delete a value from a key in ARC_Config <br /></td></tr>
<tr class="separator:af84f4d14d9da265c9f136b832a16bc9c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a810e986107e108c65fe808edbd6371af" id="r_a810e986107e108c65fe808edbd6371af"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a810e986107e108c65fe808edbd6371af">ARC_ConfigKey_AddFunc</a>) (<a class="el" href="../../df/df7/audio_2config_8h.html#aabee9667260a8e773757a111923b6c60">ARC_Config</a> *config)</td></tr>
<tr class="memdesc:a810e986107e108c65fe808edbd6371af"><td class="mdescLeft">&#160;</td><td class="mdescRight">external callback to add keys to config <br /></td></tr>
<tr class="separator:a810e986107e108c65fe808edbd6371af"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:aff40cd55a3b227cd33334d1c5843ed06" id="r_aff40cd55a3b227cd33334d1c5843ed06"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aff40cd55a3b227cd33334d1c5843ed06">ARC_Config_AddKey</a> (<a class="el" href="../../df/df7/audio_2config_8h.html#aabee9667260a8e773757a111923b6c60">ARC_Config</a> *config, <a class="el" href="../../df/d06/structARC__String.html">ARC_String</a> *type, <a class="el" href="#a24eb640dcf65c28bc8e07ea59a733245">ARC_ConfigKeyRead</a> keyRead, <a class="el" href="#af84f4d14d9da265c9f136b832a16bc9c">ARC_ConfigKeyDelete</a> keyDelete)</td></tr>
<tr class="memdesc:aff40cd55a3b227cd33334d1c5843ed06"><td class="mdescLeft">&#160;</td><td class="mdescRight">adds a usable key to ARC_Config <br /></td></tr>
<tr class="separator:aff40cd55a3b227cd33334d1c5843ed06"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a16b8895da92529e4c6ede062db2e417e" id="r_a16b8895da92529e4c6ede062db2e417e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a16b8895da92529e4c6ede062db2e417e">ARC_Config_AddKeyCString</a> (<a class="el" href="../../df/df7/audio_2config_8h.html#aabee9667260a8e773757a111923b6c60">ARC_Config</a> *config, const char *type, uint64_t length, <a class="el" href="#a24eb640dcf65c28bc8e07ea59a733245">ARC_ConfigKeyRead</a> keyRead, <a class="el" href="#af84f4d14d9da265c9f136b832a16bc9c">ARC_ConfigKeyDelete</a> keyDelete)</td></tr>
<tr class="memdesc:a16b8895da92529e4c6ede062db2e417e"><td class="mdescLeft">&#160;</td><td class="mdescRight">adds a key from a cstring <br /></td></tr>
<tr class="separator:a16b8895da92529e4c6ede062db2e417e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3bf1d8c89c92e8dd42ecd6105dc78306" id="r_a3bf1d8c89c92e8dd42ecd6105dc78306"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3bf1d8c89c92e8dd42ecd6105dc78306">ARC_Config_Create</a> (<a class="el" href="../../df/df7/audio_2config_8h.html#aabee9667260a8e773757a111923b6c60">ARC_Config</a> **config)</td></tr>
<tr class="memdesc:a3bf1d8c89c92e8dd42ecd6105dc78306"><td class="mdescLeft">&#160;</td><td class="mdescRight">creates ARC_Config type <br /></td></tr>
<tr class="separator:a3bf1d8c89c92e8dd42ecd6105dc78306"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae771a007a23bb925494d68ae7ca212be" id="r_ae771a007a23bb925494d68ae7ca212be"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae771a007a23bb925494d68ae7ca212be">ARC_Config_Destroy</a> (<a class="el" href="../../df/df7/audio_2config_8h.html#aabee9667260a8e773757a111923b6c60">ARC_Config</a> *config)</td></tr>
<tr class="memdesc:ae771a007a23bb925494d68ae7ca212be"><td class="mdescLeft">&#160;</td><td class="mdescRight">destroys ARC_Config type <br /></td></tr>
<tr class="separator:ae771a007a23bb925494d68ae7ca212be"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa1ec47a354f6cc1ee8356a098cf5b3c9" id="r_aa1ec47a354f6cc1ee8356a098cf5b3c9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa1ec47a354f6cc1ee8356a098cf5b3c9">ARC_Config_SetGroup</a> (<a class="el" href="../../df/df7/audio_2config_8h.html#aabee9667260a8e773757a111923b6c60">ARC_Config</a> *config, <a class="el" href="../../df/d06/structARC__String.html">ARC_String</a> *groupname)</td></tr>
<tr class="memdesc:aa1ec47a354f6cc1ee8356a098cf5b3c9"><td class="mdescLeft">&#160;</td><td class="mdescRight">sets current group in config <br /></td></tr>
<tr class="separator:aa1ec47a354f6cc1ee8356a098cf5b3c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4bd96f3f4cf016f82ffaf82f679288c4" id="r_a4bd96f3f4cf016f82ffaf82f679288c4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4bd96f3f4cf016f82ffaf82f679288c4">ARC_Config_Get</a> (<a class="el" href="../../df/df7/audio_2config_8h.html#aabee9667260a8e773757a111923b6c60">ARC_Config</a> *config, <a class="el" href="../../df/d06/structARC__String.html">ARC_String</a> *keyname, void **value)</td></tr>
<tr class="memdesc:a4bd96f3f4cf016f82ffaf82f679288c4"><td class="mdescLeft">&#160;</td><td class="mdescRight">get a value from a given keyname <br /></td></tr>
<tr class="separator:a4bd96f3f4cf016f82ffaf82f679288c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad6467c7d5aa224d49620fabc990d13f3" id="r_ad6467c7d5aa224d49620fabc990d13f3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad6467c7d5aa224d49620fabc990d13f3">ARC_Config_FileIO</a> (<a class="el" href="../../df/df7/audio_2config_8h.html#aabee9667260a8e773757a111923b6c60">ARC_Config</a> *config, <a class="el" href="../../df/d06/structARC__String.html">ARC_String</a> *path, uint8_t command)</td></tr>
<tr class="memdesc:ad6467c7d5aa224d49620fabc990d13f3"><td class="mdescLeft">&#160;</td><td class="mdescRight">handles file io for ARC_Config Type <br /></td></tr>
<tr class="separator:ad6467c7d5aa224d49620fabc990d13f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a696d760ea66fed20ff42c3aaac0f9609" name="a696d760ea66fed20ff42c3aaac0f9609"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a696d760ea66fed20ff42c3aaac0f9609">&#9670;&#160;</a></span>ARC_CONFIG_FILE_IO_LOAD</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARC_CONFIG_FILE_IO_LOAD&#160;&#160;&#160;0x00</td>
</tr>
</table>
</div><div class="memdoc">
<p>commands that can be used in ARC_Config_FileIO </p>
<p class="definition">Definition at line <a class="el" href="../../d3/d58/std_2config_8h_source.html#l00107">107</a> of file <a class="el" href="../../d3/d58/std_2config_8h_source.html">config.h</a>.</p>
</div>
</div>
<a id="a101688a6bcee61c9a68cdc4a9fea8ce6" name="a101688a6bcee61c9a68cdc4a9fea8ce6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a101688a6bcee61c9a68cdc4a9fea8ce6">&#9670;&#160;</a></span>ARC_CONFIG_FILE_IO_UNLOAD</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARC_CONFIG_FILE_IO_UNLOAD&#160;&#160;&#160;0x01</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="../../d3/d58/std_2config_8h_source.html#l00108">108</a> of file <a class="el" href="../../d3/d58/std_2config_8h_source.html">config.h</a>.</p>
</div>
</div>
<a id="aebe7e30736515ea92af7365a8c05e269" name="aebe7e30736515ea92af7365a8c05e269"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aebe7e30736515ea92af7365a8c05e269">&#9670;&#160;</a></span>ARC_GROUP_BUCKET_SIZE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARC_GROUP_BUCKET_SIZE&#160;&#160;&#160;0x20</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="../../d3/d58/std_2config_8h_source.html#l00013">13</a> of file <a class="el" href="../../d3/d58/std_2config_8h_source.html">config.h</a>.</p>
</div>
</div>
<a id="a2979878127e519a90fc5276c19405a55" name="a2979878127e519a90fc5276c19405a55"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2979878127e519a90fc5276c19405a55">&#9670;&#160;</a></span>ARC_GROUP_DATA_BUCKET_SIZE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARC_GROUP_DATA_BUCKET_SIZE&#160;&#160;&#160;0x20</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="../../d3/d58/std_2config_8h_source.html#l00014">14</a> of file <a class="el" href="../../d3/d58/std_2config_8h_source.html">config.h</a>.</p>
</div>
</div>
<a id="aa8d55a1d202b495b292e51919ee099d1" name="aa8d55a1d202b495b292e51919ee099d1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa8d55a1d202b495b292e51919ee099d1">&#9670;&#160;</a></span>ARC_KEY_BUCKET_SIZE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARC_KEY_BUCKET_SIZE&#160;&#160;&#160;0x20</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="../../d3/d58/std_2config_8h_source.html#l00012">12</a> of file <a class="el" href="../../d3/d58/std_2config_8h_source.html">config.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="a810e986107e108c65fe808edbd6371af" name="a810e986107e108c65fe808edbd6371af"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a810e986107e108c65fe808edbd6371af">&#9670;&#160;</a></span>ARC_ConfigKey_AddFunc</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* ARC_ConfigKey_AddFunc) (<a class="el" href="../../df/df7/audio_2config_8h.html#aabee9667260a8e773757a111923b6c60">ARC_Config</a> *config)</td>
</tr>
</table>
</div><div class="memdoc">
<p>external callback to add keys to config </p>
<p class="definition">Definition at line <a class="el" href="../../d3/d58/std_2config_8h_source.html#l00069">69</a> of file <a class="el" href="../../d3/d58/std_2config_8h_source.html">config.h</a>.</p>
</div>
</div>
<a id="af84f4d14d9da265c9f136b832a16bc9c" name="af84f4d14d9da265c9f136b832a16bc9c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af84f4d14d9da265c9f136b832a16bc9c">&#9670;&#160;</a></span>ARC_ConfigKeyDelete</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* ARC_ConfigKeyDelete) (<a class="el" href="../../df/df7/audio_2config_8h.html#aabee9667260a8e773757a111923b6c60">ARC_Config</a> *config, <a class="el" href="../../df/d06/structARC__String.html">ARC_String</a> *string, void *value)</td>
</tr>
</table>
</div><div class="memdoc">
<p>a function to delete a value from a key in ARC_Config </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">config</td><td>ARC_Config that can be used to check for references in data </td></tr>
<tr><td class="paramname">value</td><td>pointer of data to be deleted</td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>this function can be NULL if memory does not need to be cleaned for this type if there is an error, set arc_errno </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../d3/d58/std_2config_8h_source.html#l00044">44</a> of file <a class="el" href="../../d3/d58/std_2config_8h_source.html">config.h</a>.</p>
</div>
</div>
<a id="a24eb640dcf65c28bc8e07ea59a733245" name="a24eb640dcf65c28bc8e07ea59a733245"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a24eb640dcf65c28bc8e07ea59a733245">&#9670;&#160;</a></span>ARC_ConfigKeyRead</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef uint8_t(* ARC_ConfigKeyRead) (<a class="el" href="../../df/df7/audio_2config_8h.html#aabee9667260a8e773757a111923b6c60">ARC_Config</a> *config, <a class="el" href="../../df/d06/structARC__String.html">ARC_String</a> *string, void **value)</td>
</tr>
</table>
</div><div class="memdoc">
<p>a function to read a key from string to a ARC_ConfigTypeTemplate </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">config</td><td>ARC_Config to store data to </td></tr>
<tr><td class="paramname">string</td><td><a class="el" href="../../df/d06/structARC__String.html" title="substring position within a string">ARC_String</a> of data that is being read in </td></tr>
<tr><td class="paramname">value</td><td>value that is read in</td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>use ARC_Config_StoreValue(ARC_Config *config, ARC_String *name, void *value); to store a value to the config if there is an error, set arc_errno</dd></dl>
<dl class="section return"><dt>Returns</dt><dd>0 if value not a reference, 1 if value is a reference </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../d3/d58/std_2config_8h_source.html#l00033">33</a> of file <a class="el" href="../../d3/d58/std_2config_8h_source.html">config.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="aff40cd55a3b227cd33334d1c5843ed06" name="aff40cd55a3b227cd33334d1c5843ed06"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aff40cd55a3b227cd33334d1c5843ed06">&#9670;&#160;</a></span>ARC_Config_AddKey()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_Config_AddKey </td>
<td>(</td>
<td class="paramtype"><a class="el" href="../../df/df7/audio_2config_8h.html#aabee9667260a8e773757a111923b6c60">ARC_Config</a> *</td> <td class="paramname"><span class="paramname"><em>config</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="../../df/d06/structARC__String.html">ARC_String</a> *</td> <td class="paramname"><span class="paramname"><em>type</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="#a24eb640dcf65c28bc8e07ea59a733245">ARC_ConfigKeyRead</a></td> <td class="paramname"><span class="paramname"><em>keyRead</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="#af84f4d14d9da265c9f136b832a16bc9c">ARC_ConfigKeyDelete</a></td> <td class="paramname"><span class="paramname"><em>keyDelete</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>adds a usable key to ARC_Config </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">config</td><td>ARC_Config to add keys to </td></tr>
<tr><td class="paramname">type</td><td>string of key type </td></tr>
<tr><td class="paramname">keyRead</td><td>function for reading/creating key from string </td></tr>
<tr><td class="paramname">keyDelete</td><td>function for deleting stored key </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a16b8895da92529e4c6ede062db2e417e" name="a16b8895da92529e4c6ede062db2e417e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a16b8895da92529e4c6ede062db2e417e">&#9670;&#160;</a></span>ARC_Config_AddKeyCString()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_Config_AddKeyCString </td>
<td>(</td>
<td class="paramtype"><a class="el" href="../../df/df7/audio_2config_8h.html#aabee9667260a8e773757a111923b6c60">ARC_Config</a> *</td> <td class="paramname"><span class="paramname"><em>config</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>type</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint64_t</td> <td class="paramname"><span class="paramname"><em>length</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="#a24eb640dcf65c28bc8e07ea59a733245">ARC_ConfigKeyRead</a></td> <td class="paramname"><span class="paramname"><em>keyRead</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="#af84f4d14d9da265c9f136b832a16bc9c">ARC_ConfigKeyDelete</a></td> <td class="paramname"><span class="paramname"><em>keyDelete</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>adds a key from a cstring </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">config</td><td>ARC_Config to add keys to </td></tr>
<tr><td class="paramname">type</td><td>cstring of key type </td></tr>
<tr><td class="paramname">length</td><td>length of cstring </td></tr>
<tr><td class="paramname">keyRead</td><td>function for reading/creating key from string </td></tr>
<tr><td class="paramname">keyDelete</td><td>function for deleting stored key </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a3bf1d8c89c92e8dd42ecd6105dc78306" name="a3bf1d8c89c92e8dd42ecd6105dc78306"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3bf1d8c89c92e8dd42ecd6105dc78306">&#9670;&#160;</a></span>ARC_Config_Create()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_Config_Create </td>
<td>(</td>
<td class="paramtype"><a class="el" href="../../df/df7/audio_2config_8h.html#aabee9667260a8e773757a111923b6c60">ARC_Config</a> **</td> <td class="paramname"><span class="paramname"><em>config</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>creates ARC_Config type </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">config</td><td>ARC_Config to initialize </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ae771a007a23bb925494d68ae7ca212be" name="ae771a007a23bb925494d68ae7ca212be"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae771a007a23bb925494d68ae7ca212be">&#9670;&#160;</a></span>ARC_Config_Destroy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_Config_Destroy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="../../df/df7/audio_2config_8h.html#aabee9667260a8e773757a111923b6c60">ARC_Config</a> *</td> <td class="paramname"><span class="paramname"><em>config</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>destroys ARC_Config type </p>
</div>
</div>
<a id="ad6467c7d5aa224d49620fabc990d13f3" name="ad6467c7d5aa224d49620fabc990d13f3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad6467c7d5aa224d49620fabc990d13f3">&#9670;&#160;</a></span>ARC_Config_FileIO()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_Config_FileIO </td>
<td>(</td>
<td class="paramtype"><a class="el" href="../../df/df7/audio_2config_8h.html#aabee9667260a8e773757a111923b6c60">ARC_Config</a> *</td> <td class="paramname"><span class="paramname"><em>config</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="../../df/d06/structARC__String.html">ARC_String</a> *</td> <td class="paramname"><span class="paramname"><em>path</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t</td> <td class="paramname"><span class="paramname"><em>command</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>handles file io for ARC_Config Type </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">config</td><td>ARC_Config where io operations will take place </td></tr>
<tr><td class="paramname">path</td><td>file path for io </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a4bd96f3f4cf016f82ffaf82f679288c4" name="a4bd96f3f4cf016f82ffaf82f679288c4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4bd96f3f4cf016f82ffaf82f679288c4">&#9670;&#160;</a></span>ARC_Config_Get()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_Config_Get </td>
<td>(</td>
<td class="paramtype"><a class="el" href="../../df/df7/audio_2config_8h.html#aabee9667260a8e773757a111923b6c60">ARC_Config</a> *</td> <td class="paramname"><span class="paramname"><em>config</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="../../df/d06/structARC__String.html">ARC_String</a> *</td> <td class="paramname"><span class="paramname"><em>keyname</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void **</td> <td class="paramname"><span class="paramname"><em>value</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>get a value from a given keyname </p>
<dl class="section note"><dt>Note</dt><dd>name may be prefaced with &lt;group&gt;:: to specify group</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">config</td><td>ARC_Config to get value from </td></tr>
<tr><td class="paramname">keyname</td><td>name of key to get from config </td></tr>
<tr><td class="paramname">value</td><td>data retrieved from config </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aa1ec47a354f6cc1ee8356a098cf5b3c9" name="aa1ec47a354f6cc1ee8356a098cf5b3c9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa1ec47a354f6cc1ee8356a098cf5b3c9">&#9670;&#160;</a></span>ARC_Config_SetGroup()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_Config_SetGroup </td>
<td>(</td>
<td class="paramtype"><a class="el" href="../../df/df7/audio_2config_8h.html#aabee9667260a8e773757a111923b6c60">ARC_Config</a> *</td> <td class="paramname"><span class="paramname"><em>config</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="../../df/d06/structARC__String.html">ARC_String</a> *</td> <td class="paramname"><span class="paramname"><em>groupname</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>sets current group in config </p>
<dl class="section note"><dt>Note</dt><dd>ARC_Config_Get will use this set group</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">config</td><td>ARC_Config we are setting current group in </td></tr>
<tr><td class="paramname">groupname</td><td>name of group that will be set </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.9.2-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul><li class="navelem"><a class="el" href="../../dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="../../dir_8698ff38f6ae643760cdad826b9d4736.html">arc</a></li><li class="navelem"><a class="el" href="../../dir_b3e500eb3a6fe660b1141f591e523c76.html">std</a></li><li class="navelem"><a class="el" href="../../d3/d58/std_2config_8h.html">config.h</a></li></ul>
</div>
<script type="text/javascript">
// script for doxygen 1.9.1
$(function() {
toggleButton = document.createElement('doxygen-awesome-dark-mode-toggle')
toggleButton.title = "Toggle Light/Dark Mode"
$(document).ready(function(){
document.getElementById("MSearchBox").parentNode.appendChild(toggleButton)
})
$(window).resize(function(){
document.getElementById("MSearchBox").parentNode.appendChild(toggleButton)
})
})
</script>
</body>
</html>
Reference in a new issue View git blame Copy permalink