embedaddon/confuse/doc/html/structcfg__t.html - view

File: [ELWIX - Embedded LightWeight unIX -] / embedaddon / confuse / doc / html / structcfg__t.html
Revision 1.1.1.2 (vendor branch): download - view: text, annotated - select for diffs - revision graph
Wed Mar 17 00:49:17 2021 UTC (3 years, 3 months ago) by misho
Branches: confuse, MAIN
CVS tags: v3_3, HEAD

confuse 3.3

1: <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 2: <html xmlns="http://www.w3.org/1999/xhtml"> 3: <head> 4: <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> 5: <meta http-equiv="X-UA-Compatible" content="IE=9"/> 6: <meta name="generator" content="Doxygen 1.8.17"/> 7: <title>confuse: cfg_t Struct Reference</title> 8: <link href="tabs.css" rel="stylesheet" type="text/css"/> 9: <script type="text/javascript" src="jquery.js"></script> 10: <script type="text/javascript" src="dynsections.js"></script> 11: <link href="search/search.css" rel="stylesheet" type="text/css"/> 12: <script type="text/javascript" src="search/searchdata.js"></script> 13: <script type="text/javascript" src="search/search.js"></script> 14: <link href="doxygen.css" rel="stylesheet" type="text/css" /> 15: </head> 16: <body> 17: <div id="top"> 18: <div id="titlearea"> 19: <table cellspacing="0" cellpadding="0"> 20: <tbody> 21: <tr style="height: 56px;"> 22: <td id="projectalign" style="padding-left: 0.5em;"> 23: <div id="projectname">confuse 24:  <span id="projectnumber">3.3</span> 25: </div> 26: </td> 27: </tr> 28: </tbody> 29: </table> 30: </div> 31:  32:  33: <script type="text/javascript"> 34: /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ 35: var searchBox = new SearchBox("searchBox", "search",false,'Search'); 36: /* @license-end */ 37: </script> 38: <script type="text/javascript" src="menudata.js"></script> 39: <script type="text/javascript" src="menu.js"></script> 40: <script type="text/javascript"> 41: /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ 42: $(function() { 43: initMenu('',true,false,'search.php','Search'); 44: $(document).ready(function() { init_search(); }); 45: }); 46: /* @license-end */</script> 47: <div id="main-nav"></div> 48:  49: <div id="MSearchSelectWindow" 50: onmouseover="return searchBox.OnSearchSelectShow()" 51: onmouseout="return searchBox.OnSearchSelectHide()" 52: onkeydown="return searchBox.OnSearchSelectKey(event)"> 53: </div> 54: 55:  56: <div id="MSearchResultsWindow"> 57: <iframe src="javascript:void(0)" frameborder="0" 58: name="MSearchResults" id="MSearchResults"> 59: </iframe> 60: </div> 61: 62: </div> 63: <div class="header"> 64: <div class="summary"> 65: <a href="#pub-attribs">Data Fields</a> </div> 66: <div class="headertitle"> 67: <div class="title">cfg_t Struct Reference</div> </div> 68: </div> 69: <div class="contents"> 70: 71: <p>Data structure holding information about a "section". 72: <a href="structcfg__t.html#details">More...</a></p> 73: 74: <p><code>#include <<a class="el" href="confuse_8h_source.html">confuse.h</a>></code></p> 75: <table class="memberdecls"> 76: <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> 77: Data Fields</h2></td></tr> 78: <tr class="memitem:a9b4066552cd320b6a7f34fb6593474d1"><td class="memItemLeft" align="right" valign="top"><a id="a9b4066552cd320b6a7f34fb6593474d1"></a> 79: cfg_flag_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structcfg__t.html#a9b4066552cd320b6a7f34fb6593474d1">flags</a></td></tr> 80: <tr class="memdesc:a9b4066552cd320b6a7f34fb6593474d1"><td class="mdescLeft"> </td><td class="mdescRight">Any flags passed to <a class="el" href="confuse_8h.html#aec07794916564c8ab437e030ac618aa8" title="Create and initialize a cfg_t structure.">cfg_init()</a> <br /></td></tr> 81: <tr class="separator:a9b4066552cd320b6a7f34fb6593474d1"><td class="memSeparator" colspan="2"> </td></tr> 82: <tr class="memitem:a725fb2555ab71a36eb8f5c461c731e64"><td class="memItemLeft" align="right" valign="top"><a id="a725fb2555ab71a36eb8f5c461c731e64"></a> 83: char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structcfg__t.html#a725fb2555ab71a36eb8f5c461c731e64">name</a></td></tr> 84: <tr class="memdesc:a725fb2555ab71a36eb8f5c461c731e64"><td class="mdescLeft"> </td><td class="mdescRight">The name of this section, the root section returned from <a class="el" href="confuse_8h.html#aec07794916564c8ab437e030ac618aa8" title="Create and initialize a cfg_t structure.">cfg_init()</a> is always named "root". <br /></td></tr> 85: <tr class="separator:a725fb2555ab71a36eb8f5c461c731e64"><td class="memSeparator" colspan="2"> </td></tr> 86: <tr class="memitem:ab4be96e6713f164062c07b4e2a2c51b2"><td class="memItemLeft" align="right" valign="top"><a id="ab4be96e6713f164062c07b4e2a2c51b2"></a> 87: char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structcfg__t.html#ab4be96e6713f164062c07b4e2a2c51b2">comment</a></td></tr> 88: <tr class="memdesc:ab4be96e6713f164062c07b4e2a2c51b2"><td class="mdescLeft"> </td><td class="mdescRight">Optional annotation/comment. <br /></td></tr> 89: <tr class="separator:ab4be96e6713f164062c07b4e2a2c51b2"><td class="memSeparator" colspan="2"> </td></tr> 90: <tr class="memitem:a2afb9c3a1087ff2cecd893ff7ab65123"><td class="memItemLeft" align="right" valign="top"><a id="a2afb9c3a1087ff2cecd893ff7ab65123"></a> 91: <a class="el" href="structcfg__opt__t.html">cfg_opt_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structcfg__t.html#a2afb9c3a1087ff2cecd893ff7ab65123">opts</a></td></tr> 92: <tr class="memdesc:a2afb9c3a1087ff2cecd893ff7ab65123"><td class="mdescLeft"> </td><td class="mdescRight">Array of options. <br /></td></tr> 93: <tr class="separator:a2afb9c3a1087ff2cecd893ff7ab65123"><td class="memSeparator" colspan="2"> </td></tr> 94: <tr class="memitem:a74db29ce5d3b2d4cf99b9db1f6f5139d"><td class="memItemLeft" align="right" valign="top"><a id="a74db29ce5d3b2d4cf99b9db1f6f5139d"></a> 95: char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structcfg__t.html#a74db29ce5d3b2d4cf99b9db1f6f5139d">title</a></td></tr> 96: <tr class="memdesc:a74db29ce5d3b2d4cf99b9db1f6f5139d"><td class="mdescLeft"> </td><td class="mdescRight">Optional title for this section, only set if CFGF_TITLE flag is set. <br /></td></tr> 97: <tr class="separator:a74db29ce5d3b2d4cf99b9db1f6f5139d"><td class="memSeparator" colspan="2"> </td></tr> 98: <tr class="memitem:af4a7d62ed73689853a0045412ab30a24"><td class="memItemLeft" align="right" valign="top"><a id="af4a7d62ed73689853a0045412ab30a24"></a> 99: char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structcfg__t.html#af4a7d62ed73689853a0045412ab30a24">filename</a></td></tr> 100: <tr class="memdesc:af4a7d62ed73689853a0045412ab30a24"><td class="mdescLeft"> </td><td class="mdescRight">Name of the file being parsed. <br /></td></tr> 101: <tr class="separator:af4a7d62ed73689853a0045412ab30a24"><td class="memSeparator" colspan="2"> </td></tr> 102: <tr class="memitem:a5bd45667c23f040a20b2f2c0eacf7b1b"><td class="memItemLeft" align="right" valign="top"><a id="a5bd45667c23f040a20b2f2c0eacf7b1b"></a> 103: int </td><td class="memItemRight" valign="bottom"><a class="el" href="structcfg__t.html#a5bd45667c23f040a20b2f2c0eacf7b1b">line</a></td></tr> 104: <tr class="memdesc:a5bd45667c23f040a20b2f2c0eacf7b1b"><td class="mdescLeft"> </td><td class="mdescRight">Line number in the config file. <br /></td></tr> 105: <tr class="separator:a5bd45667c23f040a20b2f2c0eacf7b1b"><td class="memSeparator" colspan="2"> </td></tr> 106: <tr class="memitem:a63b77129d671d1a7b2179c2aeb52ad10"><td class="memItemLeft" align="right" valign="top"><a class="el" href="confuse_8h.html#a21921b63558b504a7f68cf97ba3cf3ce">cfg_errfunc_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structcfg__t.html#a63b77129d671d1a7b2179c2aeb52ad10">errfunc</a></td></tr> 107: <tr class="memdesc:a63b77129d671d1a7b2179c2aeb52ad10"><td class="mdescLeft"> </td><td class="mdescRight">This function (if set with cfg_set_error_function) is called for any error message. <a href="structcfg__t.html#a63b77129d671d1a7b2179c2aeb52ad10">More...</a><br /></td></tr> 108: <tr class="separator:a63b77129d671d1a7b2179c2aeb52ad10"><td class="memSeparator" colspan="2"> </td></tr> 109: <tr class="memitem:af6c59f8d119f4f06db13220129db0b5e"><td class="memItemLeft" align="right" valign="top"><a id="af6c59f8d119f4f06db13220129db0b5e"></a> 110: cfg_searchpath_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="structcfg__t.html#af6c59f8d119f4f06db13220129db0b5e">path</a></td></tr> 111: <tr class="memdesc:af6c59f8d119f4f06db13220129db0b5e"><td class="mdescLeft"> </td><td class="mdescRight">Linked list of directories to search. <br /></td></tr> 112: <tr class="separator:af6c59f8d119f4f06db13220129db0b5e"><td class="memSeparator" colspan="2"> </td></tr> 113: <tr class="memitem:a7fed5a4a0254e3f014c3a4e83caf4ca4"><td class="memItemLeft" align="right" valign="top"><a id="a7fed5a4a0254e3f014c3a4e83caf4ca4"></a> 114: <a class="el" href="confuse_8h.html#ac0d704ca318d6a83072f3e6860965694">cfg_print_filter_func_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structcfg__t.html#a7fed5a4a0254e3f014c3a4e83caf4ca4">pff</a></td></tr> 115: <tr class="memdesc:a7fed5a4a0254e3f014c3a4e83caf4ca4"><td class="mdescLeft"> </td><td class="mdescRight">Printing filter function. <br /></td></tr> 116: <tr class="separator:a7fed5a4a0254e3f014c3a4e83caf4ca4"><td class="memSeparator" colspan="2"> </td></tr> 117: </table> 118: <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> 119: <div class="textblock"><p>Data structure holding information about a "section". </p> 120: <p>Sections can be nested. A section has a list of options (strings, numbers, booleans or other sections) grouped together. </p> 121: <dl class="section examples"><dt>Examples</dt><dd><a class="el" href="ftpconf_8c-example.html#_a0">ftpconf.c</a>, <a class="el" href="reread_8c-example.html#_a0">reread.c</a>, and <a class="el" href="simple_8c-example.html#_a6">simple.c</a>.</dd> 122: </dl> 123: </div><h2 class="groupheader">Field Documentation</h2> 124: <a id="a63b77129d671d1a7b2179c2aeb52ad10"></a> 125: <h2 class="memtitle"><span class="permalink"><a href="#a63b77129d671d1a7b2179c2aeb52ad10">◆ </a></span>errfunc</h2> 126: 127: <div class="memitem"> 128: <div class="memproto"> 129: <table class="memname"> 130: <tr> 131: <td class="memname"><a class="el" href="confuse_8h.html#a21921b63558b504a7f68cf97ba3cf3ce">cfg_errfunc_t</a> cfg_t::errfunc</td> 132: </tr> 133: </table> 134: </div><div class="memdoc"> 135: 136: <p>This function (if set with cfg_set_error_function) is called for any error message. </p> 137: 138: </div> 139: </div> 140: </div> 141:  142: <hr class="footer"/><address class="footer"><small> 143: Generated by  <a href="http://www.doxygen.org/index.html"> 144: <img class="footer" src="doxygen.png" alt="doxygen"/> 145: </a> 1.8.17 146: </small></address> 147: </body> 148: </html>