/
githubmirror
/
libeconf
Обзор
Документация
Войти
/
githubmirror
/
libeconf
Код
Запросы
0
Пакеты
0
Релизы
0
Аналитика
Безопасность
master
docs/libeconf__ext_8h.html
270 строк
14 KB
Stefan Schubert
update docu
27 апр 2026, 15:03
27 апр 2026, 15:03
a9d0c3d
Код
Авторство
О чём код?
<!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" lang="en-US"> <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.14.0"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>libeconf: include/libeconf_ext.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> <script type="text/javascript" src="clipboard.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="cookie.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 id="projectrow"> <td id="projectalign"> <div id="projectname">libeconf<span id="projectnumber"> 0.8.3</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.14.0 --> <script type="text/javascript"> $(function() { codefold.init(); }); </script> <script type="text/javascript" src="menudata.js"></script> <script type="text/javascript" src="menu.js"></script> <script type="text/javascript"> $(function() { initMenu('',false,false,'search.php','Search',true); }); </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"> $(function(){initNavTree('libeconf__ext_8h.html','',''); }); </script> <div id="container"> <div id="doc-content"> <div class="header"> <div class="headertitle"><div class="title">libeconf_ext.h File Reference</div></div> </div><!--header--> <div class="contents"> <p>Public extended API for the econf library. <a href="#details">More...</a></p> <div class="textblock"><code>#include <stdbool.h></code><br /> <code>#include <stdint.h></code><br /> <code>#include <stdlib.h></code><br /> <code>#include "<a class="el" href="libeconf_8h_source.html">libeconf.h</a>"</code><br /> </div> <p><a href="libeconf__ext_8h_source.html">Go to the source code of this file.</a></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 id="header-nested-classes" class="groupheader"><a id="nested-classes" name="nested-classes"></a> Classes</h2></td></tr> <tr class="memitem:econf_5Fext_5Fvalue" id="r_econf_5Fext_5Fvalue"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structeconf__ext__value.html">econf_ext_value</a></td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 id="header-typedef-members" class="groupheader"><a id="typedef-members" name="typedef-members"></a> Typedefs</h2></td></tr> <tr class="memitem:a2947e32c20151f36458db1008c415989" id="r_a2947e32c20151f36458db1008c415989"><td class="memItemLeft" align="right" valign="top">typedef struct econf_ext_value </td><td class="memItemRight" valign="bottom"><a class="el" href="#a2947e32c20151f36458db1008c415989">econf_ext_value</a></td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 id="header-func-members" class="groupheader"><a id="func-members" name="func-members"></a> Functions</h2></td></tr> <tr class="memitem:aef2b0568b88fa788a7870a3b2bdd28a7" id="r_aef2b0568b88fa788a7870a3b2bdd28a7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="libeconf_8h.html#a30cb4e6c5ce4daa333646b23b20caa0a">econf_err</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#aef2b0568b88fa788a7870a3b2bdd28a7">econf_getExtValue</a> (<a class="el" href="libeconf_8h.html#a0d29e6d5c6c6d151bb3edc54019c8735">econf_file</a> *kf, const char *group, const char *key, <a class="el" href="structeconf__ext__value.html">econf_ext_value</a> **result)</td></tr> <tr class="memdesc:aef2b0568b88fa788a7870a3b2bdd28a7"><td class="mdescLeft"> </td><td class="mdescRight">Evaluating more information for given group/key. <br /></td></tr> <tr class="memitem:afd864f3b3732c1a072898b937aaebcd8" id="r_afd864f3b3732c1a072898b937aaebcd8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="libeconf_8h.html#a30cb4e6c5ce4daa333646b23b20caa0a">econf_err</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#afd864f3b3732c1a072898b937aaebcd8">econf_setExtValue</a> (<a class="el" href="libeconf_8h.html#a0d29e6d5c6c6d151bb3edc54019c8735">econf_file</a> *kf, const char *group, const char *key, const <a class="el" href="structeconf__ext__value.html">econf_ext_value</a> *value)</td></tr> <tr class="memdesc:afd864f3b3732c1a072898b937aaebcd8"><td class="mdescLeft"> </td><td class="mdescRight">Setting more information (e.g. <br /></td></tr> <tr class="memitem:a288b413a3d769a1af204c78aa11d185f" id="r_a288b413a3d769a1af204c78aa11d185f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a288b413a3d769a1af204c78aa11d185f">econf_freeExtValue</a> (<a class="el" href="structeconf__ext__value.html">econf_ext_value</a> *to_free)</td></tr> <tr class="memdesc:a288b413a3d769a1af204c78aa11d185f"><td class="mdescLeft"> </td><td class="mdescRight">Free an complete <a class="el" href="structeconf__ext__value.html">econf_ext_value</a> struct. <br /></td></tr> </table> <a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2> <div class="textblock"><p>Public extended API for the econf library. </p> <p class="definition">Definition in file <a class="el" href="libeconf__ext_8h_source.html">libeconf_ext.h</a>.</p> </div><a name="doc-typedef-members" id="doc-typedef-members"></a><h2 id="header-doc-typedef-members" class="groupheader">Typedef Documentation</h2> <a id="a2947e32c20151f36458db1008c415989" name="a2947e32c20151f36458db1008c415989"></a> <h2 class="memtitle"><span class="permalink"><a href="#a2947e32c20151f36458db1008c415989">◆ </a></span>econf_ext_value</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef struct econf_ext_value econf_ext_value</td> </tr> </table> </div><div class="memdoc"> <p class="definition">Definition at line <a class="el" href="libeconf__ext_8h_source.html#l00050">50</a> of file <a class="el" href="libeconf__ext_8h_source.html">libeconf_ext.h</a>.</p> </div> </div> <a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Function Documentation</h2> <a id="aef2b0568b88fa788a7870a3b2bdd28a7" name="aef2b0568b88fa788a7870a3b2bdd28a7"></a> <h2 class="memtitle"><span class="permalink"><a href="#aef2b0568b88fa788a7870a3b2bdd28a7">◆ </a></span>econf_getExtValue()</h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="libeconf_8h.html#a30cb4e6c5ce4daa333646b23b20caa0a">econf_err</a> econf_getExtValue </td> <td>(</td> <td class="paramtype"><a class="el" href="libeconf_8h.html#a0d29e6d5c6c6d151bb3edc54019c8735">econf_file</a> *</td> <td class="paramname"><span class="paramname"><em>kf</em></span>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>group</em></span>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>key</em></span>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="structeconf__ext__value.html">econf_ext_value</a> **</td> <td class="paramname"><span class="paramname"><em>result</em></span> )</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel extern">extern</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Evaluating more information for given group/key. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">kf</td><td>given/parsed data </td></tr> <tr><td class="paramname">group</td><td>Desired group or NULL if there is no group defined. </td></tr> <tr><td class="paramname">key</td><td>Key for which the value is requested. </td></tr> <tr><td class="paramname">result</td><td>A newly allocated struct or NULL in error case. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd><a class="el" href="libeconf_8h.html#a30cb4e6c5ce4daa333646b23b20caa0a" title="libeconf error codes">econf_err</a> ECONF_SUCCESS or error code </dd></dl> </div> </div> <a id="afd864f3b3732c1a072898b937aaebcd8" name="afd864f3b3732c1a072898b937aaebcd8"></a> <h2 class="memtitle"><span class="permalink"><a href="#afd864f3b3732c1a072898b937aaebcd8">◆ </a></span>econf_setExtValue()</h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="libeconf_8h.html#a30cb4e6c5ce4daa333646b23b20caa0a">econf_err</a> econf_setExtValue </td> <td>(</td> <td class="paramtype"><a class="el" href="libeconf_8h.html#a0d29e6d5c6c6d151bb3edc54019c8735">econf_file</a> *</td> <td class="paramname"><span class="paramname"><em>kf</em></span>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>group</em></span>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>key</em></span>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="structeconf__ext__value.html">econf_ext_value</a> *</td> <td class="paramname"><span class="paramname"><em>value</em></span> )</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel extern">extern</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Setting more information (e.g. </p> <p>comments) for given group/key. Values have to be set via econf_set<Type>Value.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">kf</td><td>given/parsed data </td></tr> <tr><td class="paramname">group</td><td>Desired group or NULL if there is no group defined. </td></tr> <tr><td class="paramname">key</td><td>Key for which the values have to be set. </td></tr> <tr><td class="paramname">value</td><td>All values which have to be set. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd><a class="el" href="libeconf_8h.html#a30cb4e6c5ce4daa333646b23b20caa0a" title="libeconf error codes">econf_err</a> ECONF_SUCCESS or error code </dd></dl> </div> </div> <a id="a288b413a3d769a1af204c78aa11d185f" name="a288b413a3d769a1af204c78aa11d185f"></a> <h2 class="memtitle"><span class="permalink"><a href="#a288b413a3d769a1af204c78aa11d185f">◆ </a></span>econf_freeExtValue()</h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void econf_freeExtValue </td> <td>(</td> <td class="paramtype"><a class="el" href="structeconf__ext__value.html">econf_ext_value</a> *</td> <td class="paramname"><span class="paramname"><em>to_free</em></span></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel extern">extern</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Free an complete <a class="el" href="structeconf__ext__value.html">econf_ext_value</a> struct. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">to_free</td><td>struct which has to be freed </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>void </dd></dl> </div> </div> </div><!-- contents --> </div><!-- doc-content --> <div id="page-nav" class="page-nav-panel"> <div id="page-nav-resize-handle"></div> <div id="page-nav-tree"> <div id="page-nav-contents"> </div><!-- page-nav-contents --> </div><!-- page-nav-tree --> </div><!-- page-nav --> </div><!-- container --> <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="navelem"><a href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a href="libeconf__ext_8h.html">libeconf_ext.h</a></li> <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.14.0 </li> </ul> </div> </body> </html>