Annotation of embedaddon/confuse/doc/html/structcfg__t.html, revision 1.1.1.1

1.1       misho       1: <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
                      2:         "http://www.w3.org/TR/html4/strict.dtd">
                      3: <html>
                      4: <head>
                      5:  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
                      6:  <title>confuse: cfg_t Struct Reference</title>
                      7:  <link rel="stylesheet" href="tutorial.css" type="text/css">
                      8: </head>
                      9: <body>
                     10: 
                     11: <div class="main">
                     12: 
                     13: <!-- doxygen-header.html ends here -->
                     14: <!-- Generated by Doxygen 1.5.8 -->
                     15: <div class="navigation" id="top">
                     16:   <div class="tabs">
                     17:     <ul>
                     18:       <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
                     19:       <li class="current"><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
                     20:       <li><a href="files.html"><span>Files</span></a></li>
                     21:       <li><a href="examples.html"><span>Examples</span></a></li>
                     22:     </ul>
                     23:   </div>
                     24:   <div class="tabs">
                     25:     <ul>
                     26:       <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
                     27:       <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
                     28:     </ul>
                     29:   </div>
                     30: </div>
                     31: <div class="contents">
                     32: <h1>cfg_t Struct Reference</h1><!-- doxytag: class="cfg_t" -->Data structure holding information about a "section".  
                     33: <a href="#_details">More...</a>
                     34: <p>
                     35: <code>#include &lt;<a class="el" href="confuse_8h-source.html">confuse.h</a>&gt;</code>
                     36: <p>
                     37: <table border="0" cellpadding="0" cellspacing="0">
                     38: <tr><td></td></tr>
                     39: <tr><td colspan="2"><br><h2>Data Fields</h2></td></tr>
                     40: <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9b4066552cd320b6a7f34fb6593474d1"></a><!-- doxytag: member="cfg_t::flags" ref="9b4066552cd320b6a7f34fb6593474d1" args="" -->
                     41: cfg_flag_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcfg__t.html#9b4066552cd320b6a7f34fb6593474d1">flags</a></td></tr>
                     42: 
                     43: <tr><td class="mdescLeft">&nbsp;</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>
                     44: <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="725fb2555ab71a36eb8f5c461c731e64"></a><!-- doxytag: member="cfg_t::name" ref="725fb2555ab71a36eb8f5c461c731e64" args="" -->
                     45: char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcfg__t.html#725fb2555ab71a36eb8f5c461c731e64">name</a></td></tr>
                     46: 
                     47: <tr><td class="mdescLeft">&nbsp;</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>
                     48: <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2afb9c3a1087ff2cecd893ff7ab65123"></a><!-- doxytag: member="cfg_t::opts" ref="2afb9c3a1087ff2cecd893ff7ab65123" args="" -->
                     49: <a class="el" href="structcfg__opt__t.html">cfg_opt_t</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcfg__t.html#2afb9c3a1087ff2cecd893ff7ab65123">opts</a></td></tr>
                     50: 
                     51: <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Array of options. <br></td></tr>
                     52: <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="74db29ce5d3b2d4cf99b9db1f6f5139d"></a><!-- doxytag: member="cfg_t::title" ref="74db29ce5d3b2d4cf99b9db1f6f5139d" args="" -->
                     53: char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcfg__t.html#74db29ce5d3b2d4cf99b9db1f6f5139d">title</a></td></tr>
                     54: 
                     55: <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Optional title for this section, only set if CFGF_TITLE flag is set. <br></td></tr>
                     56: <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f4a7d62ed73689853a0045412ab30a24"></a><!-- doxytag: member="cfg_t::filename" ref="f4a7d62ed73689853a0045412ab30a24" args="" -->
                     57: char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcfg__t.html#f4a7d62ed73689853a0045412ab30a24">filename</a></td></tr>
                     58: 
                     59: <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Name of the file being parsed. <br></td></tr>
                     60: <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5bd45667c23f040a20b2f2c0eacf7b1b"></a><!-- doxytag: member="cfg_t::line" ref="5bd45667c23f040a20b2f2c0eacf7b1b" args="" -->
                     61: int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcfg__t.html#5bd45667c23f040a20b2f2c0eacf7b1b">line</a></td></tr>
                     62: 
                     63: <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Line number in the config file. <br></td></tr>
                     64: <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="confuse_8h.html#e4244b478d80a5ec06a1f5a46dd04fbe">cfg_errfunc_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcfg__t.html#63b77129d671d1a7b2179c2aeb52ad10">errfunc</a></td></tr>
                     65: 
                     66: <tr><td class="mdescLeft">&nbsp;</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>
                     67: </table>
                     68: <hr><a name="_details"></a><h2>Detailed Description</h2>
                     69: Data structure holding information about a "section". 
                     70: <p>
                     71: 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>
                     72: 
                     73: <p>
                     74: <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>
                     75: <a class="anchor" name="63b77129d671d1a7b2179c2aeb52ad10"></a><!-- doxytag: member="cfg_t::errfunc" ref="63b77129d671d1a7b2179c2aeb52ad10" args="" -->
                     76: <div class="memitem">
                     77: <div class="memproto">
                     78:       <table class="memname">
                     79:         <tr>
                     80:           <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>
                     81:         </tr>
                     82:       </table>
                     83: </div>
                     84: <div class="memdoc">
                     85: 
                     86: <p>
                     87: This function (if set with cfg_set_error_function) is called for any error message. 
                     88: <p>
                     89: 
                     90: <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>
                     91: 
                     92: </div>
                     93: </div><p>
                     94: </div>
                     95: <!-- doxygen-footer.html starts here -->
                     96:   </div>
                     97:  </body>
                     98: </html>

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>