version 1.1.1.1, 2017/01/24 14:48:55
|
version 1.1.1.2, 2021/03/17 00:49:17
|
Line 1
|
Line 1
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
"http://www.w3.org/TR/html4/strict.dtd"> | <html xmlns="http://www.w3.org/1999/xhtml"> |
<html> | |
<head> |
<head> |
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> | <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
<title>confuse: cfg_t Struct Reference</title> | <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
<link rel="stylesheet" href="tutorial.css" type="text/css"> | <meta name="generator" content="Doxygen 1.8.17"/> |
| <title>confuse: cfg_t Struct 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> |
</head> |
<body> |
<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">confuse |
|
 <span id="projectnumber">3.3</span> |
|
</div> |
|
</td> |
|
</tr> |
|
</tbody> |
|
</table> |
|
</div> |
|
<!-- end header part --> |
|
<!-- Generated by Doxygen 1.8.17 --> |
|
<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'); |
|
/* @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> |
|
|
<div class="main"> | <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
<!-- doxygen-header.html ends here --> | <iframe src="javascript:void(0)" frameborder="0" |
<!-- Generated by Doxygen 1.5.8 --> | name="MSearchResults" id="MSearchResults"> |
<div class="navigation" id="top"> | </iframe> |
<div class="tabs"> | |
<ul> | |
<li><a href="index.html"><span>Main Page</span></a></li> | |
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li> | |
<li><a href="files.html"><span>Files</span></a></li> | |
<li><a href="examples.html"><span>Examples</span></a></li> | |
</ul> | |
</div> | |
<div class="tabs"> | |
<ul> | |
<li><a href="annotated.html"><span>Data Structures</span></a></li> | |
<li><a href="functions.html"><span>Data Fields</span></a></li> | |
</ul> | |
</div> | |
</div> |
</div> |
|
|
|
</div><!-- top --> |
|
<div class="header"> |
|
<div class="summary"> |
|
<a href="#pub-attribs">Data Fields</a> </div> |
|
<div class="headertitle"> |
|
<div class="title">cfg_t Struct Reference</div> </div> |
|
</div><!--header--> |
<div class="contents"> |
<div class="contents"> |
<h1>cfg_t Struct Reference</h1><!-- doxytag: class="cfg_t" -->Data structure holding information about a "section". |
|
<a href="#_details">More...</a> |
|
<p> |
|
<code>#include <<a class="el" href="confuse_8h-source.html">confuse.h</a>></code> |
|
<p> |
|
<table border="0" cellpadding="0" cellspacing="0"> |
|
<tr><td></td></tr> |
|
<tr><td colspan="2"><br><h2>Data Fields</h2></td></tr> |
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9b4066552cd320b6a7f34fb6593474d1"></a><!-- doxytag: member="cfg_t::flags" ref="9b4066552cd320b6a7f34fb6593474d1" args="" --> |
|
cfg_flag_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structcfg__t.html#9b4066552cd320b6a7f34fb6593474d1">flags</a></td></tr> |
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Any flags passed to <a class="el" href="confuse_8h.html#ec07794916564c8ab437e030ac618aa8" title="Create and initialize a cfg_t structure.">cfg_init()</a>. <br></td></tr> | <p>Data structure holding information about a "section". |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="725fb2555ab71a36eb8f5c461c731e64"></a><!-- doxytag: member="cfg_t::name" ref="725fb2555ab71a36eb8f5c461c731e64" args="" --> | <a href="structcfg__t.html#details">More...</a></p> |
char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structcfg__t.html#725fb2555ab71a36eb8f5c461c731e64">name</a></td></tr> | |
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">The name of this section, the root section returned from <a class="el" href="confuse_8h.html#ec07794916564c8ab437e030ac618aa8" title="Create and initialize a cfg_t structure.">cfg_init()</a> is always named "root". <br></td></tr> | <p><code>#include <<a class="el" href="confuse_8h_source.html">confuse.h</a>></code></p> |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2afb9c3a1087ff2cecd893ff7ab65123"></a><!-- doxytag: member="cfg_t::opts" ref="2afb9c3a1087ff2cecd893ff7ab65123" args="" --> | <table class="memberdecls"> |
<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#2afb9c3a1087ff2cecd893ff7ab65123">opts</a></td></tr> | <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> |
| Data Fields</h2></td></tr> |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Array of options. <br></td></tr> | <tr class="memitem:a9b4066552cd320b6a7f34fb6593474d1"><td class="memItemLeft" align="right" valign="top"><a id="a9b4066552cd320b6a7f34fb6593474d1"></a> |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="74db29ce5d3b2d4cf99b9db1f6f5139d"></a><!-- doxytag: member="cfg_t::title" ref="74db29ce5d3b2d4cf99b9db1f6f5139d" args="" --> | cfg_flag_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structcfg__t.html#a9b4066552cd320b6a7f34fb6593474d1">flags</a></td></tr> |
char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structcfg__t.html#74db29ce5d3b2d4cf99b9db1f6f5139d">title</a></td></tr> | <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> |
| <tr class="separator:a9b4066552cd320b6a7f34fb6593474d1"><td class="memSeparator" colspan="2"> </td></tr> |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Optional title for this section, only set if CFGF_TITLE flag is set. <br></td></tr> | <tr class="memitem:a725fb2555ab71a36eb8f5c461c731e64"><td class="memItemLeft" align="right" valign="top"><a id="a725fb2555ab71a36eb8f5c461c731e64"></a> |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f4a7d62ed73689853a0045412ab30a24"></a><!-- doxytag: member="cfg_t::filename" ref="f4a7d62ed73689853a0045412ab30a24" args="" --> | char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structcfg__t.html#a725fb2555ab71a36eb8f5c461c731e64">name</a></td></tr> |
char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structcfg__t.html#f4a7d62ed73689853a0045412ab30a24">filename</a></td></tr> | <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> |
| <tr class="separator:a725fb2555ab71a36eb8f5c461c731e64"><td class="memSeparator" colspan="2"> </td></tr> |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Name of the file being parsed. <br></td></tr> | <tr class="memitem:ab4be96e6713f164062c07b4e2a2c51b2"><td class="memItemLeft" align="right" valign="top"><a id="ab4be96e6713f164062c07b4e2a2c51b2"></a> |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5bd45667c23f040a20b2f2c0eacf7b1b"></a><!-- doxytag: member="cfg_t::line" ref="5bd45667c23f040a20b2f2c0eacf7b1b" args="" --> | char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structcfg__t.html#ab4be96e6713f164062c07b4e2a2c51b2">comment</a></td></tr> |
int </td><td class="memItemRight" valign="bottom"><a class="el" href="structcfg__t.html#5bd45667c23f040a20b2f2c0eacf7b1b">line</a></td></tr> | <tr class="memdesc:ab4be96e6713f164062c07b4e2a2c51b2"><td class="mdescLeft"> </td><td class="mdescRight">Optional annotation/comment. <br /></td></tr> |
| <tr class="separator:ab4be96e6713f164062c07b4e2a2c51b2"><td class="memSeparator" colspan="2"> </td></tr> |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Line number in the config file. <br></td></tr> | <tr class="memitem:a2afb9c3a1087ff2cecd893ff7ab65123"><td class="memItemLeft" align="right" valign="top"><a id="a2afb9c3a1087ff2cecd893ff7ab65123"></a> |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="confuse_8h.html#e4244b478d80a5ec06a1f5a46dd04fbe">cfg_errfunc_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structcfg__t.html#63b77129d671d1a7b2179c2aeb52ad10">errfunc</a></td></tr> | <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> |
| <tr class="memdesc:a2afb9c3a1087ff2cecd893ff7ab65123"><td class="mdescLeft"> </td><td class="mdescRight">Array of options. <br /></td></tr> |
<tr><td class="mdescLeft"> </td><td class="mdescRight">This function (if set with cfg_set_error_function) is called for any error message. <a href="#63b77129d671d1a7b2179c2aeb52ad10"></a><br></td></tr> | <tr class="separator:a2afb9c3a1087ff2cecd893ff7ab65123"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a74db29ce5d3b2d4cf99b9db1f6f5139d"><td class="memItemLeft" align="right" valign="top"><a id="a74db29ce5d3b2d4cf99b9db1f6f5139d"></a> |
| char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structcfg__t.html#a74db29ce5d3b2d4cf99b9db1f6f5139d">title</a></td></tr> |
| <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> |
| <tr class="separator:a74db29ce5d3b2d4cf99b9db1f6f5139d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af4a7d62ed73689853a0045412ab30a24"><td class="memItemLeft" align="right" valign="top"><a id="af4a7d62ed73689853a0045412ab30a24"></a> |
| char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structcfg__t.html#af4a7d62ed73689853a0045412ab30a24">filename</a></td></tr> |
| <tr class="memdesc:af4a7d62ed73689853a0045412ab30a24"><td class="mdescLeft"> </td><td class="mdescRight">Name of the file being parsed. <br /></td></tr> |
| <tr class="separator:af4a7d62ed73689853a0045412ab30a24"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5bd45667c23f040a20b2f2c0eacf7b1b"><td class="memItemLeft" align="right" valign="top"><a id="a5bd45667c23f040a20b2f2c0eacf7b1b"></a> |
| int </td><td class="memItemRight" valign="bottom"><a class="el" href="structcfg__t.html#a5bd45667c23f040a20b2f2c0eacf7b1b">line</a></td></tr> |
| <tr class="memdesc:a5bd45667c23f040a20b2f2c0eacf7b1b"><td class="mdescLeft"> </td><td class="mdescRight">Line number in the config file. <br /></td></tr> |
| <tr class="separator:a5bd45667c23f040a20b2f2c0eacf7b1b"><td class="memSeparator" colspan="2"> </td></tr> |
| <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> |
| <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> |
| <tr class="separator:a63b77129d671d1a7b2179c2aeb52ad10"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af6c59f8d119f4f06db13220129db0b5e"><td class="memItemLeft" align="right" valign="top"><a id="af6c59f8d119f4f06db13220129db0b5e"></a> |
| cfg_searchpath_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="structcfg__t.html#af6c59f8d119f4f06db13220129db0b5e">path</a></td></tr> |
| <tr class="memdesc:af6c59f8d119f4f06db13220129db0b5e"><td class="mdescLeft"> </td><td class="mdescRight">Linked list of directories to search. <br /></td></tr> |
| <tr class="separator:af6c59f8d119f4f06db13220129db0b5e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7fed5a4a0254e3f014c3a4e83caf4ca4"><td class="memItemLeft" align="right" valign="top"><a id="a7fed5a4a0254e3f014c3a4e83caf4ca4"></a> |
| <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> |
| <tr class="memdesc:a7fed5a4a0254e3f014c3a4e83caf4ca4"><td class="mdescLeft"> </td><td class="mdescRight">Printing filter function. <br /></td></tr> |
| <tr class="separator:a7fed5a4a0254e3f014c3a4e83caf4ca4"><td class="memSeparator" colspan="2"> </td></tr> |
</table> |
</table> |
<hr><a name="_details"></a><h2>Detailed Description</h2> | <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
Data structure holding information about a "section". | <div class="textblock"><p>Data structure holding information about a "section". </p> |
<p> | <p>Sections can be nested. A section has a list of options (strings, numbers, booleans or other sections) grouped together. </p> |
Sections can be nested. A section has a list of options (strings, numbers, booleans or other sections) grouped together. <dl compact><dt><b>Examples: </b></dt><dd> | <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> |
| </dl> |
| </div><h2 class="groupheader">Field Documentation</h2> |
| <a id="a63b77129d671d1a7b2179c2aeb52ad10"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a63b77129d671d1a7b2179c2aeb52ad10">◆ </a></span>errfunc</h2> |
|
|
<p> |
|
<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>.</dl><hr><h2>Field Documentation</h2> |
|
<a class="anchor" name="63b77129d671d1a7b2179c2aeb52ad10"></a><!-- doxytag: member="cfg_t::errfunc" ref="63b77129d671d1a7b2179c2aeb52ad10" args="" --> |
|
<div class="memitem"> |
<div class="memitem"> |
<div class="memproto"> |
<div class="memproto"> |
<table class="memname"> |
<table class="memname"> |
<tr> |
<tr> |
<td class="memname"><a class="el" href="confuse_8h.html#e4244b478d80a5ec06a1f5a46dd04fbe">cfg_errfunc_t</a> <a class="el" href="structcfg__t.html#63b77129d671d1a7b2179c2aeb52ad10">cfg_t::errfunc</a> </td> | <td class="memname"><a class="el" href="confuse_8h.html#a21921b63558b504a7f68cf97ba3cf3ce">cfg_errfunc_t</a> cfg_t::errfunc</td> |
</tr> |
</tr> |
</table> |
</table> |
</div> | </div><div class="memdoc"> |
<div class="memdoc"> | |
|
|
<p> | <p>This function (if set with cfg_set_error_function) is called for any error message. </p> |
This function (if set with cfg_set_error_function) is called for any error message. | |
<p> | |
|
|
<p>Referenced by <a class="el" href="confuse_8c-source.html#l00730">cfg_error()</a>, <a class="el" href="confuse_8c-source.html#l01093">cfg_init()</a>, <a class="el" href="confuse_8c-source.html#l00719">cfg_set_error_function()</a>, and <a class="el" href="confuse_8c-source.html#l00531">cfg_setopt()</a>.</p> |
|
|
|
</div> |
</div> |
</div><p> |
|
</div> |
</div> |
<!-- doxygen-footer.html starts here --> | </div><!-- contents --> |
</div> | <!-- start footer part --> |
</body> | <hr class="footer"/><address class="footer"><small> |
| Generated by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.17 |
| </small></address> |
| </body> |
</html> |
</html> |