[BACK]Return to structcfg__opt__t.html CVS log [TXT] [DIR] Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / confuse / doc / html
File:  [ELWIX - Embedded LightWeight unIX -] / embedaddon / confuse / doc / html / structcfg__opt__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, 4 months ago) by misho
Branches: confuse, MAIN
CVS tags: v3_3, HEAD
confuse 3.3

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<title>confuse: cfg_opt_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>
<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
   &#160;<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&amp;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&amp;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>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle">
<div class="title">cfg_opt_t Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Data structure holding information about an option.  
 <a href="structcfg__opt__t.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="confuse_8h_source.html">confuse.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a0754fed6c0e415e12d7fe4ecfd2b3295"><td class="memItemLeft" align="right" valign="top"><a id="a0754fed6c0e415e12d7fe4ecfd2b3295"></a>
const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcfg__opt__t.html#a0754fed6c0e415e12d7fe4ecfd2b3295">name</a></td></tr>
<tr class="memdesc:a0754fed6c0e415e12d7fe4ecfd2b3295"><td class="mdescLeft">&#160;</td><td class="mdescRight">The name of the option. <br /></td></tr>
<tr class="separator:a0754fed6c0e415e12d7fe4ecfd2b3295"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8eac503e744faf87c8ec1cdb7f6d8648"><td class="memItemLeft" align="right" valign="top"><a id="a8eac503e744faf87c8ec1cdb7f6d8648"></a>
char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcfg__opt__t.html#a8eac503e744faf87c8ec1cdb7f6d8648">comment</a></td></tr>
<tr class="memdesc:a8eac503e744faf87c8ec1cdb7f6d8648"><td class="mdescLeft">&#160;</td><td class="mdescRight">Optional comment/annotation. <br /></td></tr>
<tr class="separator:a8eac503e744faf87c8ec1cdb7f6d8648"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0cdd99a97da9f62a6876421571842c5a"><td class="memItemLeft" align="right" valign="top"><a id="a0cdd99a97da9f62a6876421571842c5a"></a>
<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>
<tr class="memdesc:a0cdd99a97da9f62a6876421571842c5a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type of option. <br /></td></tr>
<tr class="separator:a0cdd99a97da9f62a6876421571842c5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af6c23c379f0c391d665faeaaf9c49d64"><td class="memItemLeft" align="right" valign="top"><a id="af6c23c379f0c391d665faeaaf9c49d64"></a>
unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcfg__opt__t.html#af6c23c379f0c391d665faeaaf9c49d64">nvalues</a></td></tr>
<tr class="memdesc:af6c23c379f0c391d665faeaaf9c49d64"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of values parsed. <br /></td></tr>
<tr class="separator:af6c23c379f0c391d665faeaaf9c49d64"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aed01618b386409cdd2305ba2ec3b5028"><td class="memItemLeft" align="right" valign="top"><a id="aed01618b386409cdd2305ba2ec3b5028"></a>
<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>
<tr class="memdesc:aed01618b386409cdd2305ba2ec3b5028"><td class="mdescLeft">&#160;</td><td class="mdescRight">Array of found values. <br /></td></tr>
<tr class="separator:aed01618b386409cdd2305ba2ec3b5028"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adba3a76e9eccb195383327f645f79da0"><td class="memItemLeft" align="right" valign="top"><a id="adba3a76e9eccb195383327f645f79da0"></a>
cfg_flag_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcfg__opt__t.html#adba3a76e9eccb195383327f645f79da0">flags</a></td></tr>
<tr class="memdesc:adba3a76e9eccb195383327f645f79da0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flags. <br /></td></tr>
<tr class="separator:adba3a76e9eccb195383327f645f79da0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa3361a9b809e83d22e911b32e10387d9"><td class="memItemLeft" align="right" valign="top"><a id="aa3361a9b809e83d22e911b32e10387d9"></a>
<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>
<tr class="memdesc:aa3361a9b809e83d22e911b32e10387d9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Suboptions (only applies to sections) <br /></td></tr>
<tr class="separator:aa3361a9b809e83d22e911b32e10387d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2b7d4ec69eb37823f90989e876fe59be"><td class="memItemLeft" align="right" valign="top"><a id="a2b7d4ec69eb37823f90989e876fe59be"></a>
<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>
<tr class="memdesc:a2b7d4ec69eb37823f90989e876fe59be"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default value. <br /></td></tr>
<tr class="separator:a2b7d4ec69eb37823f90989e876fe59be"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7ae186c0caf8c6208675e08a7a608448"><td class="memItemLeft" align="right" valign="top"><a id="a7ae186c0caf8c6208675e08a7a608448"></a>
<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>
<tr class="memdesc:a7ae186c0caf8c6208675e08a7a608448"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function callback for CFGT_FUNC options. <br /></td></tr>
<tr class="separator:a7ae186c0caf8c6208675e08a7a608448"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a74cd795bf14bcbc4fd5f8993e1ec241a"><td class="memItemLeft" align="right" valign="top"><a id="a74cd795bf14bcbc4fd5f8993e1ec241a"></a>
<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>
<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>
<tr class="separator:a74cd795bf14bcbc4fd5f8993e1ec241a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5c391c4830df02c70d92c1438fee812e"><td class="memItemLeft" align="right" valign="top"><a id="a5c391c4830df02c70d92c1438fee812e"></a>
<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>
<tr class="memdesc:a5c391c4830df02c70d92c1438fee812e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Value parsing callback function. <br /></td></tr>
<tr class="separator:a5c391c4830df02c70d92c1438fee812e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a99bfdb357aca5b75254352a54fd6f9be"><td class="memItemLeft" align="right" valign="top"><a id="a99bfdb357aca5b75254352a54fd6f9be"></a>
<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>
<tr class="memdesc:a99bfdb357aca5b75254352a54fd6f9be"><td class="mdescLeft">&#160;</td><td class="mdescRight">Value validating parsing callback function. <br /></td></tr>
<tr class="separator:a99bfdb357aca5b75254352a54fd6f9be"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8a6eefc8e2c0efe76587fef68c5c3331"><td class="memItemLeft" align="right" valign="top"><a id="a8a6eefc8e2c0efe76587fef68c5c3331"></a>
<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>
<tr class="memdesc:a8a6eefc8e2c0efe76587fef68c5c3331"><td class="mdescLeft">&#160;</td><td class="mdescRight">Value validating set callback function. <br /></td></tr>
<tr class="separator:a8a6eefc8e2c0efe76587fef68c5c3331"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad6b58f20b560e054150136fe1818cc44"><td class="memItemLeft" align="right" valign="top"><a id="ad6b58f20b560e054150136fe1818cc44"></a>
<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>
<tr class="memdesc:ad6b58f20b560e054150136fe1818cc44"><td class="mdescLeft">&#160;</td><td class="mdescRight">print callback function <br /></td></tr>
<tr class="separator:ad6b58f20b560e054150136fe1818cc44"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Data structure holding information about an option. </p>
<p>The value(s) are stored as an array of fundamental values (strings, numbers, etc). </p>
<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>
</dl>
</div></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>