Annotation of embedaddon/confuse/doc/html/structcfg__opt__t.html, revision 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_opt_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 Page</span></a></li>
! 19: <li class="current"><a href="annotated.html"><span>Data 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 Structures</span></a></li>
! 27: <li><a href="functions.html"><span>Data Fields</span></a></li>
! 28: </ul>
! 29: </div>
! 30: </div>
! 31: <div class="contents">
! 32: <h1>cfg_opt_t Struct Reference</h1><!-- doxytag: class="cfg_opt_t" -->Data structure holding information about an option.
! 33: <a href="#_details">More...</a>
! 34: <p>
! 35: <code>#include <<a class="el" href="confuse_8h-source.html">confuse.h</a>></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="2acae1acce8676cef5cf9d90d5198188"></a><!-- doxytag: member="cfg_opt_t::name" ref="2acae1acce8676cef5cf9d90d5198188" args="" -->
! 41: char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structcfg__opt__t.html#2acae1acce8676cef5cf9d90d5198188">name</a></td></tr>
! 42:
! 43: <tr><td class="mdescLeft"> </td><td class="mdescRight">The name of the option. <br></td></tr>
! 44: <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0cdd99a97da9f62a6876421571842c5a"></a><!-- doxytag: member="cfg_opt_t::type" ref="0cdd99a97da9f62a6876421571842c5a" args="" -->
! 45: <a class="el" href="confuse_8h.html#9c62155b0deae0e1831507520a2ff7c7">cfg_type_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structcfg__opt__t.html#0cdd99a97da9f62a6876421571842c5a">type</a></td></tr>
! 46:
! 47: <tr><td class="mdescLeft"> </td><td class="mdescRight">Type of option. <br></td></tr>
! 48: <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f6c23c379f0c391d665faeaaf9c49d64"></a><!-- doxytag: member="cfg_opt_t::nvalues" ref="f6c23c379f0c391d665faeaaf9c49d64" args="" -->
! 49: unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="structcfg__opt__t.html#f6c23c379f0c391d665faeaaf9c49d64">nvalues</a></td></tr>
! 50:
! 51: <tr><td class="mdescLeft"> </td><td class="mdescRight">Number of values parsed. <br></td></tr>
! 52: <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ed01618b386409cdd2305ba2ec3b5028"></a><!-- doxytag: member="cfg_opt_t::values" ref="ed01618b386409cdd2305ba2ec3b5028" args="" -->
! 53: <a class="el" href="unioncfg__value__t.html">cfg_value_t</a> ** </td><td class="memItemRight" valign="bottom"><a class="el" href="structcfg__opt__t.html#ed01618b386409cdd2305ba2ec3b5028">values</a></td></tr>
! 54:
! 55: <tr><td class="mdescLeft"> </td><td class="mdescRight">Array of found values. <br></td></tr>
! 56: <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="dba3a76e9eccb195383327f645f79da0"></a><!-- doxytag: member="cfg_opt_t::flags" ref="dba3a76e9eccb195383327f645f79da0" args="" -->
! 57: cfg_flag_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structcfg__opt__t.html#dba3a76e9eccb195383327f645f79da0">flags</a></td></tr>
! 58:
! 59: <tr><td class="mdescLeft"> </td><td class="mdescRight">Flags. <br></td></tr>
! 60: <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a3361a9b809e83d22e911b32e10387d9"></a><!-- doxytag: member="cfg_opt_t::subopts" ref="a3361a9b809e83d22e911b32e10387d9" args="" -->
! 61: <a class="el" href="structcfg__opt__t.html">cfg_opt_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structcfg__opt__t.html#a3361a9b809e83d22e911b32e10387d9">subopts</a></td></tr>
! 62:
! 63: <tr><td class="mdescLeft"> </td><td class="mdescRight">Suboptions (only applies to sections). <br></td></tr>
! 64: <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2b7d4ec69eb37823f90989e876fe59be"></a><!-- doxytag: member="cfg_opt_t::def" ref="2b7d4ec69eb37823f90989e876fe59be" args="" -->
! 65: <a class="el" href="structcfg__defvalue__t.html">cfg_defvalue_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structcfg__opt__t.html#2b7d4ec69eb37823f90989e876fe59be">def</a></td></tr>
! 66:
! 67: <tr><td class="mdescLeft"> </td><td class="mdescRight">Default value. <br></td></tr>
! 68: <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7ae186c0caf8c6208675e08a7a608448"></a><!-- doxytag: member="cfg_opt_t::func" ref="7ae186c0caf8c6208675e08a7a608448" args="" -->
! 69: <a class="el" href="confuse_8h.html#f781d6e81a4dec706ae4d9848b26918d">cfg_func_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structcfg__opt__t.html#7ae186c0caf8c6208675e08a7a608448">func</a></td></tr>
! 70:
! 71: <tr><td class="mdescLeft"> </td><td class="mdescRight">Function callback for CFGT_FUNC options. <br></td></tr>
! 72: <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="aee50731d3e47f2037155d05c7628fa4"></a><!-- doxytag: member="cfg_opt_t::simple_value" ref="aee50731d3e47f2037155d05c7628fa4" args="" -->
! 73: void * </td><td class="memItemRight" valign="bottom"><a class="el" href="structcfg__opt__t.html#aee50731d3e47f2037155d05c7628fa4">simple_value</a></td></tr>
! 74:
! 75: <tr><td class="mdescLeft"> </td><td class="mdescRight">Pointer to user-specified variable to store simple values (created with the CFG_SIMPLE_* initializers). <br></td></tr>
! 76: <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5c391c4830df02c70d92c1438fee812e"></a><!-- doxytag: member="cfg_opt_t::parsecb" ref="5c391c4830df02c70d92c1438fee812e" args="" -->
! 77: <a class="el" href="confuse_8h.html#352a1a9074937ca131860891ed5c18c0">cfg_callback_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structcfg__opt__t.html#5c391c4830df02c70d92c1438fee812e">parsecb</a></td></tr>
! 78:
! 79: <tr><td class="mdescLeft"> </td><td class="mdescRight">Value parsing callback function. <br></td></tr>
! 80: <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="99bfdb357aca5b75254352a54fd6f9be"></a><!-- doxytag: member="cfg_opt_t::validcb" ref="99bfdb357aca5b75254352a54fd6f9be" args="" -->
! 81: <a class="el" href="confuse_8h.html#4d01aba329210d110238d64d2047d502">cfg_validate_callback_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structcfg__opt__t.html#99bfdb357aca5b75254352a54fd6f9be">validcb</a></td></tr>
! 82:
! 83: <tr><td class="mdescLeft"> </td><td class="mdescRight">Value validating callback function. <br></td></tr>
! 84: <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d6b58f20b560e054150136fe1818cc44"></a><!-- doxytag: member="cfg_opt_t::pf" ref="d6b58f20b560e054150136fe1818cc44" args="" -->
! 85: <a class="el" href="confuse_8h.html#488182780ff16a94457f0d1242416154">cfg_print_func_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structcfg__opt__t.html#d6b58f20b560e054150136fe1818cc44">pf</a></td></tr>
! 86:
! 87: <tr><td class="mdescLeft"> </td><td class="mdescRight">print callback function <br></td></tr>
! 88: </table>
! 89: <hr><a name="_details"></a><h2>Detailed Description</h2>
! 90: Data structure holding information about an option.
! 91: <p>
! 92: The value(s) are stored as an array of fundamental values (strings, numbers, etc). <dl compact><dt><b>Examples: </b></dt><dd>
! 93:
! 94: <p>
! 95: <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>.</dl></div>
! 96: <!-- doxygen-footer.html starts here -->
! 97: </div>
! 98: </body>
! 99: </html>
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>