/usr/share/doc/libucommon-dev/a00060.html is in libucommon-doc 3.2.0-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 | <!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"/>
<title>UCommon: ucc::keydata Class Reference</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.6.3 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="a00214.html">ucc</a>::<a class="el" href="a00060.html">keydata</a>
</div>
</div>
<div class="contents">
<h1>ucc::keydata Class Reference</h1><!-- doxytag: class="ucc::keydata" --><!-- doxytag: inherits="ucc::OrderedObject" -->
<p>Data keys parsed from a keyfile.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00194_source.html">keydata.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for ucc::keydata:</div>
<div class="dynsection">
<div class="center"><img src="a00402.png" border="0" usemap="#ucc_1_1keydata_inherit__map" alt="Inheritance graph"/></div>
<map name="ucc_1_1keydata_inherit__map" id="ucc_1_1keydata_inherit__map">
<area shape="rect" id="node2" href="a00100.html" title="A linked object base class for ordered objects." alt="" coords="5,160,149,189"/><area shape="rect" id="node4" href="a00069.html" title="Common base class for all objects that can be formed into a linked list." alt="" coords="11,83,144,112"/><area shape="rect" id="node6" href="a00093.html" title="A common base class for all managed objects." alt="" coords="31,5,124,35"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ucc::keydata:</div>
<div class="dynsection">
<div class="center"><img src="a00403.png" border="0" usemap="#ucc_1_1keydata_coll__map" alt="Collaboration graph"/></div>
<map name="ucc_1_1keydata_coll__map" id="ucc_1_1keydata_coll__map">
<area shape="rect" id="node12" href="a00062.html" title="Traditional keypair config file parsing class." alt="" coords="89,491,180,520"/><area shape="rect" id="node2" href="a00100.html" title="A linked object base class for ordered objects." alt="" coords="17,187,161,216"/><area shape="rect" id="node9" href="a00099.html" title="An index container for maintaining an ordered list of objects." alt="" coords="89,299,228,328"/><area shape="rect" id="node4" href="a00069.html" title="Common base class for all objects that can be formed into a linked list." alt="" coords="23,96,156,125"/><area shape="rect" id="node6" href="a00093.html" title="A common base class for all managed objects." alt="" coords="43,5,136,35"/><area shape="rect" id="node14" href="a00080.html" title="An alternate memory pager private heap manager." alt="" coords="217,395,332,424"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Data Structures</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="a00061.html">keyvalue</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A key value set is used for iterative access. <a href="a00061.html#_details">More...</a><br/></td></tr>
<tr><td colspan="2"><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa452deb9693febcc38536d48ed1a877f"></a><!-- doxytag: member="ucc::keydata::iterator" ref="aa452deb9693febcc38536d48ed1a877f" args="" -->
typedef <a class="el" href="a00066.html">linked_pointer</a>< <a class="el" href="a00061.html">keyvalue</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="a00060.html#aa452deb9693febcc38536d48ed1a877f">iterator</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convenience typedef for iterative pointer. <br/></td></tr>
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00061.html">keyvalue</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00060.html#a7b0f6926773755514bb7cacb5364dffb">begin</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get first value object, for iterative examinations. <a href="#a7b0f6926773755514bb7cacb5364dffb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00060.html#a60bffcafe9cd620a2ad789e244ced84f">clear</a> (const char *id)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove a keyword id from the keydata structure. <a href="#a60bffcafe9cd620a2ad789e244ced84f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00061.html">keyvalue</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00060.html#ac386670bf4abae6d9776c86414b5c651">end</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get last value object, for iterative examinations. <a href="#ac386670bf4abae6d9776c86414b5c651"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00060.html#a07d1f55d5711cd5fc174ec36c5ecf2fb">get</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the name of this section. <a href="#a07d1f55d5711cd5fc174ec36c5ecf2fb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00060.html#a6522637fb5b15567f9edfc156e1f522a">get</a> (const char *id) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Lookup a key value by it's id. <a href="#a6522637fb5b15567f9edfc156e1f522a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00060.html#a4aad8912c35c9b115c19d544ac220e35">operator()</a> (const char *id) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Lookup a key value by it's id. <a href="#a4aad8912c35c9b115c19d544ac220e35"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00060.html#a993d08ab14464703ff9408a9e34ee5e2">set</a> (const char *id, const char *value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a keyword and value in the keydata structure. <a href="#a993d08ab14464703ff9408a9e34ee5e2"></a><br/></td></tr>
<tr><td colspan="2"><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2d376dc4ac3b77e2e177221bef1452a7"></a><!-- doxytag: member="ucc::keydata::keyfile" ref="a2d376dc4ac3b77e2e177221bef1452a7" args="" -->
class </td><td class="memItemRight" valign="bottom"><b>keyfile</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae9bfaa01de4a4552ed59dda754fd0ad9"></a><!-- doxytag: member="ucc::keydata::keyvalue" ref="ae9bfaa01de4a4552ed59dda754fd0ad9" args="" -->
class </td><td class="memItemRight" valign="bottom"><b>keyvalue</b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Data keys parsed from a keyfile. </p>
<p>This is a specific [] section from a fully loaded keyfile, and offers common means to access data members. This is related to the original GNU Common C++ keydata object, although it is formed in a keyfile class which is loaded from a config file all at once. </p>
<dl class="author"><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@gnutelephony.org">dyfet@gnutelephony.org</a>> </dd></dl>
<p>Definition at line <a class="el" href="a00194_source.html#l00057">57</a> of file <a class="el" href="a00194_source.html">keydata.h</a>.</p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a7b0f6926773755514bb7cacb5364dffb"></a><!-- doxytag: member="ucc::keydata::begin" ref="a7b0f6926773755514bb7cacb5364dffb" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00061.html">keyvalue</a>* ucc::keydata::begin </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get first value object, for iterative examinations. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>first key value in chain. </dd></dl>
<p>Definition at line <a class="el" href="a00194_source.html#l00128">128</a> of file <a class="el" href="a00194_source.html">keydata.h</a>.</p>
</div>
</div>
<a class="anchor" id="a60bffcafe9cd620a2ad789e244ced84f"></a><!-- doxytag: member="ucc::keydata::clear" ref="a60bffcafe9cd620a2ad789e244ced84f" args="(const char *id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucc::keydata::clear </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>id</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Remove a keyword id from the keydata structure. </p>
<p>Removed items still use pager allocated memory. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>to remove. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ac386670bf4abae6d9776c86414b5c651"></a><!-- doxytag: member="ucc::keydata::end" ref="ac386670bf4abae6d9776c86414b5c651" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00061.html">keyvalue</a>* ucc::keydata::end </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get last value object, for iterative examinations. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>first key value in chain. </dd></dl>
<p>Definition at line <a class="el" href="a00194_source.html#l00135">135</a> of file <a class="el" href="a00194_source.html">keydata.h</a>.</p>
</div>
</div>
<a class="anchor" id="a07d1f55d5711cd5fc174ec36c5ecf2fb"></a><!-- doxytag: member="ucc::keydata::get" ref="a07d1f55d5711cd5fc174ec36c5ecf2fb" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* ucc::keydata::get </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the name of this section. </p>
<p>Useful in iterative examinations. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>name of keydata section. </dd></dl>
<p>Definition at line <a class="el" href="a00194_source.html#l00121">121</a> of file <a class="el" href="a00194_source.html">keydata.h</a>.</p>
</div>
</div>
<a class="anchor" id="a6522637fb5b15567f9edfc156e1f522a"></a><!-- doxytag: member="ucc::keydata::get" ref="a6522637fb5b15567f9edfc156e1f522a" args="(const char *id) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* ucc::keydata::get </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>id</em></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Lookup a key value by it's id. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>to look for. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>value string or NULL if not found. </dd></dl>
</div>
</div>
<a class="anchor" id="a4aad8912c35c9b115c19d544ac220e35"></a><!-- doxytag: member="ucc::keydata::operator()" ref="a4aad8912c35c9b115c19d544ac220e35" args="(const char *id) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* ucc::keydata::operator() </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>id</em></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Lookup a key value by it's id. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>to look for. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>value string or NULL if not found. </dd></dl>
<p>Definition at line <a class="el" href="a00194_source.html#l00098">98</a> of file <a class="el" href="a00194_source.html">keydata.h</a>.</p>
</div>
</div>
<a class="anchor" id="a993d08ab14464703ff9408a9e34ee5e2"></a><!-- doxytag: member="ucc::keydata::set" ref="a993d08ab14464703ff9408a9e34ee5e2" args="(const char *id, const char *value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucc::keydata::set </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>value</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set a keyword and value in the keydata structure. </p>
<p>If the keyword already exists, it is replaced. Removed items still use pager allocated memory. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>to set. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>for the id. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>ucommon/<a class="el" href="a00194_source.html">keydata.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Tue Jul 6 08:22:30 2010 for UCommon by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
|