Annotation of embedaddon/confuse/doc/html/structcfg__opt__t.html, revision 1.1.1.2

1.1.1.2 ! misho       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">
1.1       misho       3: <head>
1.1.1.2 ! misho       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_opt_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" />
1.1       misho      15: </head>
                     16: <body>
1.1.1.2 ! misho      17: <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
        !            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:    &#160;<span id="projectnumber">3.3</span>
        !            25:    </div>
        !            26:   </td>
        !            27:  </tr>
        !            28:  </tbody>
        !            29: </table>
        !            30: </div>
        !            31: <!-- end header part -->
        !            32: <!-- Generated by Doxygen 1.8.17 -->
        !            33: <script type="text/javascript">
        !            34: /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;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&amp;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: <!-- window showing the filter options -->
        !            49: <div id="MSearchSelectWindow"
        !            50:      onmouseover="return searchBox.OnSearchSelectShow()"
        !            51:      onmouseout="return searchBox.OnSearchSelectHide()"
        !            52:      onkeydown="return searchBox.OnSearchSelectKey(event)">
1.1       misho      53: </div>
                     54: 
1.1.1.2 ! misho      55: <!-- iframe showing the search results (closed by default) -->
        !            56: <div id="MSearchResultsWindow">
        !            57: <iframe src="javascript:void(0)" frameborder="0" 
        !            58:         name="MSearchResults" id="MSearchResults">
        !            59: </iframe>
        !            60: </div>
1.1       misho      61: 
1.1.1.2 ! misho      62: </div><!-- top -->
        !            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_opt_t Struct Reference</div>  </div>
        !            68: </div><!--header-->
        !            69: <div class="contents">
1.1       misho      70: 
1.1.1.2 ! misho      71: <p>Data structure holding information about an option.  
        !            72:  <a href="structcfg__opt__t.html#details">More...</a></p>
1.1       misho      73: 
1.1.1.2 ! misho      74: <p><code>#include &lt;<a class="el" href="confuse_8h_source.html">confuse.h</a>&gt;</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:a0754fed6c0e415e12d7fe4ecfd2b3295"><td class="memItemLeft" align="right" valign="top"><a id="a0754fed6c0e415e12d7fe4ecfd2b3295"></a>
        !            79: const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcfg__opt__t.html#a0754fed6c0e415e12d7fe4ecfd2b3295">name</a></td></tr>
        !            80: <tr class="memdesc:a0754fed6c0e415e12d7fe4ecfd2b3295"><td class="mdescLeft">&#160;</td><td class="mdescRight">The name of the option. <br /></td></tr>
        !            81: <tr class="separator:a0754fed6c0e415e12d7fe4ecfd2b3295"><td class="memSeparator" colspan="2">&#160;</td></tr>
        !            82: <tr class="memitem:a8eac503e744faf87c8ec1cdb7f6d8648"><td class="memItemLeft" align="right" valign="top"><a id="a8eac503e744faf87c8ec1cdb7f6d8648"></a>
        !            83: char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcfg__opt__t.html#a8eac503e744faf87c8ec1cdb7f6d8648">comment</a></td></tr>
        !            84: <tr class="memdesc:a8eac503e744faf87c8ec1cdb7f6d8648"><td class="mdescLeft">&#160;</td><td class="mdescRight">Optional comment/annotation. <br /></td></tr>
        !            85: <tr class="separator:a8eac503e744faf87c8ec1cdb7f6d8648"><td class="memSeparator" colspan="2">&#160;</td></tr>
        !            86: <tr class="memitem:a0cdd99a97da9f62a6876421571842c5a"><td class="memItemLeft" align="right" valign="top"><a id="a0cdd99a97da9f62a6876421571842c5a"></a>
        !            87: <a class="el" href="confuse_8h.html#a9c62155b0deae0e1831507520a2ff7c7">cfg_type_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcfg__opt__t.html#a0cdd99a97da9f62a6876421571842c5a">type</a></td></tr>
        !            88: <tr class="memdesc:a0cdd99a97da9f62a6876421571842c5a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type of option. <br /></td></tr>
        !            89: <tr class="separator:a0cdd99a97da9f62a6876421571842c5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
        !            90: <tr class="memitem:af6c23c379f0c391d665faeaaf9c49d64"><td class="memItemLeft" align="right" valign="top"><a id="af6c23c379f0c391d665faeaaf9c49d64"></a>
        !            91: unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcfg__opt__t.html#af6c23c379f0c391d665faeaaf9c49d64">nvalues</a></td></tr>
        !            92: <tr class="memdesc:af6c23c379f0c391d665faeaaf9c49d64"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of values parsed. <br /></td></tr>
        !            93: <tr class="separator:af6c23c379f0c391d665faeaaf9c49d64"><td class="memSeparator" colspan="2">&#160;</td></tr>
        !            94: <tr class="memitem:aed01618b386409cdd2305ba2ec3b5028"><td class="memItemLeft" align="right" valign="top"><a id="aed01618b386409cdd2305ba2ec3b5028"></a>
        !            95: <a class="el" href="unioncfg__value__t.html">cfg_value_t</a> **&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcfg__opt__t.html#aed01618b386409cdd2305ba2ec3b5028">values</a></td></tr>
        !            96: <tr class="memdesc:aed01618b386409cdd2305ba2ec3b5028"><td class="mdescLeft">&#160;</td><td class="mdescRight">Array of found values. <br /></td></tr>
        !            97: <tr class="separator:aed01618b386409cdd2305ba2ec3b5028"><td class="memSeparator" colspan="2">&#160;</td></tr>
        !            98: <tr class="memitem:adba3a76e9eccb195383327f645f79da0"><td class="memItemLeft" align="right" valign="top"><a id="adba3a76e9eccb195383327f645f79da0"></a>
        !            99: cfg_flag_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcfg__opt__t.html#adba3a76e9eccb195383327f645f79da0">flags</a></td></tr>
        !           100: <tr class="memdesc:adba3a76e9eccb195383327f645f79da0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flags. <br /></td></tr>
        !           101: <tr class="separator:adba3a76e9eccb195383327f645f79da0"><td class="memSeparator" colspan="2">&#160;</td></tr>
        !           102: <tr class="memitem:aa3361a9b809e83d22e911b32e10387d9"><td class="memItemLeft" align="right" valign="top"><a id="aa3361a9b809e83d22e911b32e10387d9"></a>
        !           103: <a class="el" href="structcfg__opt__t.html">cfg_opt_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcfg__opt__t.html#aa3361a9b809e83d22e911b32e10387d9">subopts</a></td></tr>
        !           104: <tr class="memdesc:aa3361a9b809e83d22e911b32e10387d9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Suboptions (only applies to sections) <br /></td></tr>
        !           105: <tr class="separator:aa3361a9b809e83d22e911b32e10387d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
        !           106: <tr class="memitem:a2b7d4ec69eb37823f90989e876fe59be"><td class="memItemLeft" align="right" valign="top"><a id="a2b7d4ec69eb37823f90989e876fe59be"></a>
        !           107: <a class="el" href="structcfg__defvalue__t.html">cfg_defvalue_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcfg__opt__t.html#a2b7d4ec69eb37823f90989e876fe59be">def</a></td></tr>
        !           108: <tr class="memdesc:a2b7d4ec69eb37823f90989e876fe59be"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default value. <br /></td></tr>
        !           109: <tr class="separator:a2b7d4ec69eb37823f90989e876fe59be"><td class="memSeparator" colspan="2">&#160;</td></tr>
        !           110: <tr class="memitem:a7ae186c0caf8c6208675e08a7a608448"><td class="memItemLeft" align="right" valign="top"><a id="a7ae186c0caf8c6208675e08a7a608448"></a>
        !           111: <a class="el" href="confuse_8h.html#a775e9fa25691f0754a643c0246efcc3c">cfg_func_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcfg__opt__t.html#a7ae186c0caf8c6208675e08a7a608448">func</a></td></tr>
        !           112: <tr class="memdesc:a7ae186c0caf8c6208675e08a7a608448"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function callback for CFGT_FUNC options. <br /></td></tr>
        !           113: <tr class="separator:a7ae186c0caf8c6208675e08a7a608448"><td class="memSeparator" colspan="2">&#160;</td></tr>
        !           114: <tr class="memitem:a74cd795bf14bcbc4fd5f8993e1ec241a"><td class="memItemLeft" align="right" valign="top"><a id="a74cd795bf14bcbc4fd5f8993e1ec241a"></a>
        !           115: <a class="el" href="unioncfg__simple__t.html">cfg_simple_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcfg__opt__t.html#a74cd795bf14bcbc4fd5f8993e1ec241a">simple_value</a></td></tr>
        !           116: <tr class="memdesc:a74cd795bf14bcbc4fd5f8993e1ec241a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to user-specified variable to store simple values (created with the CFG_SIMPLE_* initializers) <br /></td></tr>
        !           117: <tr class="separator:a74cd795bf14bcbc4fd5f8993e1ec241a"><td class="memSeparator" colspan="2">&#160;</td></tr>
        !           118: <tr class="memitem:a5c391c4830df02c70d92c1438fee812e"><td class="memItemLeft" align="right" valign="top"><a id="a5c391c4830df02c70d92c1438fee812e"></a>
        !           119: <a class="el" href="confuse_8h.html#a6fd5dd8df47cbf571782463ca1e0c4b7">cfg_callback_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcfg__opt__t.html#a5c391c4830df02c70d92c1438fee812e">parsecb</a></td></tr>
        !           120: <tr class="memdesc:a5c391c4830df02c70d92c1438fee812e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Value parsing callback function. <br /></td></tr>
        !           121: <tr class="separator:a5c391c4830df02c70d92c1438fee812e"><td class="memSeparator" colspan="2">&#160;</td></tr>
        !           122: <tr class="memitem:a99bfdb357aca5b75254352a54fd6f9be"><td class="memItemLeft" align="right" valign="top"><a id="a99bfdb357aca5b75254352a54fd6f9be"></a>
        !           123: <a class="el" href="confuse_8h.html#a16da0a75f6314baedf4ed4ee2dd28d11">cfg_validate_callback_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcfg__opt__t.html#a99bfdb357aca5b75254352a54fd6f9be">validcb</a></td></tr>
        !           124: <tr class="memdesc:a99bfdb357aca5b75254352a54fd6f9be"><td class="mdescLeft">&#160;</td><td class="mdescRight">Value validating parsing callback function. <br /></td></tr>
        !           125: <tr class="separator:a99bfdb357aca5b75254352a54fd6f9be"><td class="memSeparator" colspan="2">&#160;</td></tr>
        !           126: <tr class="memitem:a8a6eefc8e2c0efe76587fef68c5c3331"><td class="memItemLeft" align="right" valign="top"><a id="a8a6eefc8e2c0efe76587fef68c5c3331"></a>
        !           127: <a class="el" href="confuse_8h.html#a5285e2294a128c40810a986ef87c6ed3">cfg_validate_callback2_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcfg__opt__t.html#a8a6eefc8e2c0efe76587fef68c5c3331">validcb2</a></td></tr>
        !           128: <tr class="memdesc:a8a6eefc8e2c0efe76587fef68c5c3331"><td class="mdescLeft">&#160;</td><td class="mdescRight">Value validating set callback function. <br /></td></tr>
        !           129: <tr class="separator:a8a6eefc8e2c0efe76587fef68c5c3331"><td class="memSeparator" colspan="2">&#160;</td></tr>
        !           130: <tr class="memitem:ad6b58f20b560e054150136fe1818cc44"><td class="memItemLeft" align="right" valign="top"><a id="ad6b58f20b560e054150136fe1818cc44"></a>
        !           131: <a class="el" href="confuse_8h.html#a1b97fb911e1203df560f80c2528c5fd9">cfg_print_func_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcfg__opt__t.html#ad6b58f20b560e054150136fe1818cc44">pf</a></td></tr>
        !           132: <tr class="memdesc:ad6b58f20b560e054150136fe1818cc44"><td class="mdescLeft">&#160;</td><td class="mdescRight">print callback function <br /></td></tr>
        !           133: <tr class="separator:ad6b58f20b560e054150136fe1818cc44"><td class="memSeparator" colspan="2">&#160;</td></tr>
1.1       misho     134: </table>
1.1.1.2 ! misho     135: <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
        !           136: <div class="textblock"><p>Data structure holding information about an option. </p>
        !           137: <p>The value(s) are stored as an array of fundamental values (strings, numbers, etc). </p>
        !           138: <dl class="section examples"><dt>Examples</dt><dd><a class="el" href="ftpconf_8c-example.html#_a1">ftpconf.c</a>, <a class="el" href="reread_8c-example.html#_a1">reread.c</a>, and <a class="el" href="simple_8c-example.html#_a0">simple.c</a>.</dd>
        !           139: </dl>
        !           140: </div></div><!-- contents -->
        !           141: <!-- start footer part -->
        !           142: <hr class="footer"/><address class="footer"><small>
        !           143: Generated by &#160;<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>
1.1       misho     148: </html>

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