diff options
Diffstat (limited to 'c-layman/doc/html/group__config.html')
| -rw-r--r-- | c-layman/doc/html/group__config.html | 238 |
1 files changed, 238 insertions, 0 deletions
diff --git a/c-layman/doc/html/group__config.html b/c-layman/doc/html/group__config.html new file mode 100644 index 0000000..674695e --- /dev/null +++ b/c-layman/doc/html/group__config.html @@ -0,0 +1,238 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>C-Layman: Config</title> +<link href="tabs.css" rel="stylesheet" type="text/css"> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.8 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="modules.html"><span>Modules</span></a></li> + <li><a href="annotated.html"><span>Data Structures</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>Config</h1>Layman library configuration module. +<a href="#_details">More...</a> +<p> +<table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Data Structures</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_bare_config.html">BareConfig</a></td></tr> + +<tr><td colspan="2"><br><h2>Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">PyObject * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__config.html#gb54f7fb79ed1ddc05112c1c2c43f7ca3">_bareConfigObject</a> (<a class="el" href="struct_bare_config.html">BareConfig</a> *c)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="struct_bare_config.html">BareConfig</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__config.html#g8838ddf22955bb74d47f38d241de2949">bareConfigCreate</a> (<a class="el" href="struct_message.html">Message</a> *m, FILE *outFd, FILE *inFd, FILE *errFd)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__config.html#g80a5608968d88456a39a1fb0bb08db8b">bareConfigFree</a> (<a class="el" href="struct_bare_config.html">BareConfig</a> *cfg)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__config.html#g4b100e2dcd1fb1f26810b264724dd5fb">bareConfigGetDefaultValue</a> (<a class="el" href="struct_bare_config.html">BareConfig</a> *cfg, const char *opt)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__config.html#g6b3a73eb7ce5be378520d2b17abc1563">bareConfigGetOptionValue</a> (<a class="el" href="struct_bare_config.html">BareConfig</a> *cfg, const char *opt)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__config.html#g034b7ef4be594a5807b41c50926edd71">bareConfigSetOptionValue</a> (<a class="el" href="struct_bare_config.html">BareConfig</a> *cfg, const char *opt, const char *val)</td></tr> + +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Layman library configuration module. <hr><h2>Function Documentation</h2> +<a class="anchor" name="gb54f7fb79ed1ddc05112c1c2c43f7ca3"></a><!-- doxytag: member="config.c::_bareConfigObject" ref="gb54f7fb79ed1ddc05112c1c2c43f7ca3" args="(BareConfig *c)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">PyObject* _bareConfigObject </td> + <td>(</td> + <td class="paramtype"><a class="el" href="struct_bare_config.html">BareConfig</a> * </td> + <td class="paramname"> <em>c</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="g8838ddf22955bb74d47f38d241de2949"></a><!-- doxytag: member="config.c::bareConfigCreate" ref="g8838ddf22955bb74d47f38d241de2949" args="(Message *m, FILE *outFd, FILE *inFd, FILE *errFd)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="struct_bare_config.html">BareConfig</a>* bareConfigCreate </td> + <td>(</td> + <td class="paramtype"><a class="el" href="struct_message.html">Message</a> * </td> + <td class="paramname"> <em>m</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">FILE * </td> + <td class="paramname"> <em>outFd</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">FILE * </td> + <td class="paramname"> <em>inFd</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">FILE * </td> + <td class="paramname"> <em>errFd</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Creates a bare config object with default values.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>outFd</em> </td><td>where information must be written to </td></tr> + <tr><td valign="top"></td><td valign="top"><em>inFd</em> </td><td>where information must be read from </td></tr> + <tr><td valign="top"></td><td valign="top"><em>errFd</em> </td><td>where errors must be written to</td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>a new instance of a <a class="el" href="struct_bare_config.html">BareConfig</a> object. It must be freed with <a class="el" href="group__config.html#g80a5608968d88456a39a1fb0bb08db8b">bareConfigFree()</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="g80a5608968d88456a39a1fb0bb08db8b"></a><!-- doxytag: member="config.c::bareConfigFree" ref="g80a5608968d88456a39a1fb0bb08db8b" args="(BareConfig *cfg)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void bareConfigFree </td> + <td>(</td> + <td class="paramtype"><a class="el" href="struct_bare_config.html">BareConfig</a> * </td> + <td class="paramname"> <em>cfg</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Frees a <a class="el" href="struct_bare_config.html">BareConfig</a> object. +</div> +</div><p> +<a class="anchor" name="g4b100e2dcd1fb1f26810b264724dd5fb"></a><!-- doxytag: member="config.c::bareConfigGetDefaultValue" ref="g4b100e2dcd1fb1f26810b264724dd5fb" args="(BareConfig *cfg, const char *opt)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">const char* bareConfigGetDefaultValue </td> + <td>(</td> + <td class="paramtype"><a class="el" href="struct_bare_config.html">BareConfig</a> * </td> + <td class="paramname"> <em>cfg</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"> <em>opt</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get an option's default value.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>opt</em> </td><td>the name of the option</td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>the value or NULL on failure. </dd></dl> + +</div> +</div><p> +<a class="anchor" name="g6b3a73eb7ce5be378520d2b17abc1563"></a><!-- doxytag: member="config.c::bareConfigGetOptionValue" ref="g6b3a73eb7ce5be378520d2b17abc1563" args="(BareConfig *cfg, const char *opt)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">const char* bareConfigGetOptionValue </td> + <td>(</td> + <td class="paramtype"><a class="el" href="struct_bare_config.html">BareConfig</a> * </td> + <td class="paramname"> <em>cfg</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"> <em>opt</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="g034b7ef4be594a5807b41c50926edd71"></a><!-- doxytag: member="config.c::bareConfigSetOptionValue" ref="g034b7ef4be594a5807b41c50926edd71" args="(BareConfig *cfg, const char *opt, const char *val)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int bareConfigSetOptionValue </td> + <td>(</td> + <td class="paramtype"><a class="el" href="struct_bare_config.html">BareConfig</a> * </td> + <td class="paramname"> <em>cfg</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"> <em>opt</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"> <em>val</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Fri Aug 6 20:00:53 2010 for C-Layman by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address> +</body> +</html> |