<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>GNU CommonC++: ost::Keydata Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.6 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li id="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul></div>
<div class="nav">
<a class="el" href="namespaceost.html">ost</a>::<a class="el" href="classost_1_1_keydata.html">Keydata</a></div>
<h1>ost::Keydata Class Reference</h1><!-- doxytag: class="ost::Keydata" --><!-- doxytag: inherits="ost::MemPager" --><a class="el" href="classost_1_1_keydata.html">Keydata</a> objects are used to load and hold "configuration" data for a given application.load text configuration files into keyword pairs.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="misc_8h-source.html">misc.h</a>></code>
<p>
<p>Inheritance diagram for ost::Keydata:
<p><center><img src="classost_1_1_keydata.png" usemap="#ost::Keydata_map" border="0" alt=""></center>
<map name="ost::Keydata_map">
<area href="classost_1_1_mem_pager.html" alt="ost::MemPager" shape="rect" coords="0,0,95,24">
</map>
<a href="classost_1_1_keydata-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_keydata.html#aa445cbcd2cb56f8fab7e3063a55ba24">load</a> (const char *keypath)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Load additional key values into the currrent object from the specfied config source (a config file/section pair). <a href="#aa445cbcd2cb56f8fab7e3063a55ba24"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_keydata.html#d5c9a37238043d8daf932e0fdc9c64e1">loadPrefix</a> (const char *prefix, const char *keypath)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Load additional key values into the currrent object from the specfied config source (a config file/section pair). <a href="#d5c9a37238043d8daf932e0fdc9c64e1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_keydata.html#739656231534d299d250d7ac85cb5b52">loadFile</a> (const char *filepath, const char *keys=NULL, const char *pre=NULL)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Load additional keys into the current object using a real filename that is directly passed rather than a computed key path. <a href="#739656231534d299d250d7ac85cb5b52"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_keydata.html#824f678a4920e40704ae17ef70b47290">load</a> (<a class="el" href="structost_1_1_keydata_1_1_define.html">Define</a> *pairs)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Load default keywords into the current object. <a href="#824f678a4920e40704ae17ef70b47290"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_keydata.html#7b38a93f1804700e069c071e7e71ec82">Keydata</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create an empty key data object. <a href="#7b38a93f1804700e069c071e7e71ec82"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_keydata.html#5d1fabffff1ebfef8b8ef3fcb610497d">Keydata</a> (const char *keypath)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new key data object and use "Load" method to load an initial config file section into it. <a href="#5d1fabffff1ebfef8b8ef3fcb610497d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_keydata.html#2ffbfc1fc3162cf22bfd3699a61aa58b">Keydata</a> (<a class="el" href="structost_1_1_keydata_1_1_define.html">Define</a> *pairs, const char *keypath=NULL)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Alternate constructor can take a define list and an optional pathfile to parse. <a href="#2ffbfc1fc3162cf22bfd3699a61aa58b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_keydata.html#ea7231d3fea8750126d1904699638c94">~Keydata</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy the keydata object and all allocated memory. <a href="#ea7231d3fea8750126d1904699638c94"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_keydata.html#5a9b6469b627a674e5e9856707732b29">unlink</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Unlink the keydata object from the cache file stream. <a href="#5a9b6469b627a674e5e9856707732b29"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_keydata.html#5d2ee13740be6e901db41dfb0e0033b6">getCount</a> (const char *sym)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a count of the number of data "values" that is associated with a specific keyword. <a href="#5d2ee13740be6e901db41dfb0e0033b6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_keydata.html#2412a569a18725e0368f445f4f1cc07a">getFirst</a> (const char *sym)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the first data value for a given keyword. <a href="#2412a569a18725e0368f445f4f1cc07a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_keydata.html#b2286284aff76cf9e310698ff6f22107">getLast</a> (const char *sym)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the last (most recently set) value for a given keyword. <a href="#b2286284aff76cf9e310698ff6f22107"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_keydata.html#73ef6b10342042f626b109c24e821b22">isKey</a> (const char *sym)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Find if a given key exists. <a href="#73ef6b10342042f626b109c24e821b22"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_keydata.html#7fcd3ce05319e4268064386784a714c5">getString</a> (const char *sym, const char *def=NULL)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a string value, with an optional default if missing. <a href="#7fcd3ce05319e4268064386784a714c5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_keydata.html#d950a91035be68c3b790dc783d286651">getLong</a> (const char *sym, long def=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a long value, with an optional default if missing. <a href="#d950a91035be68c3b790dc783d286651"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_keydata.html#297f5a7239a22576f770b038baac564f">getBool</a> (const char *key)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a bool value. <a href="#297f5a7239a22576f770b038baac564f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_keydata.html#727c000bb0cbbe8132d676e00e4b7424">getDouble</a> (const char *key, double def=0.)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a floating value. <a href="#727c000bb0cbbe8132d676e00e4b7424"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_keydata.html#85b680ae3a530b5261c9e4993365e6cd">getIndex</a> (char **data, unsigned max)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get an index array of ALL keywords that are stored by the current keydata object. <a href="#85b680ae3a530b5261c9e4993365e6cd"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_keydata.html#177f94fc01430d2f5e4a79cbbea64b03">getCount</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the count of keyword indexes that are actually available so one can allocate a table to receive getIndex. <a href="#177f94fc01430d2f5e4a79cbbea64b03"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_keydata.html#815ad7e73ec110d57f205f8971972a0c">setValue</a> (const char *sym, const char *data)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set (replace) the value of a given keyword. <a href="#815ad7e73ec110d57f205f8971972a0c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char *const * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_keydata.html#ffdaf274202fe5bb12b6dc720f2cb3b7">getList</a> (const char *sym)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a list of all values set for the given keyword returned in order. <a href="#ffdaf274202fe5bb12b6dc720f2cb3b7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_keydata.html#68af2fafb65d0d583d62c351faca42cd">clrValue</a> (const char *sym)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Clear all values associated with a given keyword. <a href="#68af2fafb65d0d583d62c351faca42cd"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_keydata.html#1891928115aa1007abe42d81a695c205">operator[]</a> (const char *keyword)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A convient notation for accessing the keydata as an associative array of keyword/value pairs through the [] operator. <a href="#1891928115aa1007abe42d81a695c205"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_keydata.html#f16246e1f7c5af075493bf37d7e1b48f">end</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">static member to end keydata i/o allocations. <a href="#f16246e1f7c5af075493bf37d7e1b48f"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structost_1_1_keydata_1_1_keysym.html">Keysym</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_keydata.html#76bcec1ca452d8811d797a7fea2c9e96">getSymbol</a> (const char *sym, bool create)</td></tr>
<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_keydata.html#b2cdccf30c8543716905fbc6dfa29c92">endKeydata</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Shutdown the file stream cache. <a href="#b2cdccf30c8543716905fbc6dfa29c92"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structost_1_1_keydata_1_1_define.html">Define</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structost_1_1_keydata_1_1_keysym.html">Keysym</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structost_1_1_keydata_1_1_keyval.html">Keyval</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<a class="el" href="classost_1_1_keydata.html">Keydata</a> objects are used to load and hold "configuration" data for a given application.load text configuration files into keyword pairs.
<p>
This class is used to load and then hold "<code>keyword = value</code>" pairs parsed from a text based "config" file that has been divided into "<code>[sections]</code>". The syntax is:<p>
<code><pre>
[section_name]
key1=value1
key2=value2</pre></code><p>
Essentially, the "path" is a "keypath" into a theoretical namespace of key pairs, hence one does not use "real" filepaths that may be OS dependent. The "<code>/</code>" path refers to "<code>/etc</code>" prefixed (on UNIX) directories and this is processed within the constructor. It could refer to the <code>/config</code> prefix on QNX, or even, gasp, a "<code>C:\WINDOWS</code>". Hence, a keypath of "<code>/bayonne.d/vmhost/smtp</code>" actually resolves to a "<code>/etc/bayonne.d/vmhost.conf</code>" and loads key value pairs from the <code>[smtp]</code> section of that <code>.conf</code> file.<p>
Similarly, something like "<code>~bayonne/smtp</code>" path refers to a "<code>~/.bayonnerc</code>" and loads key pairs from the <code>[smtp]</code> section. This coercion occurs before the name is passed to the open call.<p>
I actually use derived keydata based classes as global initialized objects, and they hence automatically load and parse config file entries even before "main" has started.<p>
<a class="el" href="classost_1_1_keydata.html">Keydata</a> can hold multiple values for the same key pair. This can occur either from storing a "list" of data items in a config file, or when overlaying multiple config sources (such as <code>/etc/....conf</code> and <code>~/.confrc</code> segments) into a single object. The keys are stored as cumulative (read-only/replacable) config values under a hash index system for quick retrieval.<p>
<a class="el" href="classost_1_1_keydata.html">Keydata</a> can also load a table of "initialization" values for keyword pairs that were not found in the external file.<p>
One typically derives an application specific keydata class to load a specific portion of a known config file and initialize it's values. One can then declare a global instance of these objects and have configuration data initialized automatically as the executable is loaded.<p>
Hence, if I have a "[paths]" section in a "<code>/etc/server.conf?</code>" file, I might define something like:<p>
<code><pre>
class KeyPaths : public <a class="el" href="classost_1_1_keydata.html">Keydata</a>
{
public:
KeyPaths() : <a class="el" href="classost_1_1_keydata.html">Keydata</a>("/server/paths")
{
static <a class="el" href="structost_1_1_keydata_1_1_define.html">Keydata::Define</a> *defvalues = {
{"datafiles", "/var/server"},
{NULL, NULL}};</pre></code><p>
<code><pre> // override with [paths] from "~/.serverrc" if avail.</pre></code><p>
<code><pre> load("~server/paths");
load(defvalues);
}
};</pre></code><p>
<code><pre> KeyPaths keypaths;
</pre></code><p>
<dl compact><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@ostel.com">dyfet@ostel.com</a>> </dd></dl>
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="7b38a93f1804700e069c071e7e71ec82"></a><!-- doxytag: member="ost::Keydata::Keydata" ref="7b38a93f1804700e069c071e7e71ec82" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">ost::Keydata::Keydata </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Create an empty key data object.
<p>
</td>
</tr>
</table>
<a class="anchor" name="5d1fabffff1ebfef8b8ef3fcb610497d"></a><!-- doxytag: member="ost::Keydata::Keydata" ref="5d1fabffff1ebfef8b8ef3fcb610497d" args="(const char *keypath)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">ost::Keydata::Keydata </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname1" valign="top" nowrap> <em>keypath</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Create a new key data object and use "Load" method to load an initial config file section into it.
<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>keypath</em> </td><td>(filepath/section) specifies the home path. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="2ffbfc1fc3162cf22bfd3699a61aa58b"></a><!-- doxytag: member="ost::Keydata::Keydata" ref="2ffbfc1fc3162cf22bfd3699a61aa58b" args="(Define *pairs, const char *keypath=NULL)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">ost::Keydata::Keydata </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="structost_1_1_keydata_1_1_define.html">Define</a> * </td>
<td class="mdname" nowrap> <em>pairs</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const char * </td>
<td class="mdname" nowrap> <em>keypath</em> = <code>NULL</code></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Alternate constructor can take a define list and an optional pathfile to parse.
<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>pairs</em> </td><td>of keyword values from a define list </td></tr>
<tr><td valign="top"></td><td valign="top"><em>keypath</em> </td><td>of optional file and section to load from </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="ea7231d3fea8750126d1904699638c94"></a><!-- doxytag: member="ost::Keydata::~Keydata" ref="ea7231d3fea8750126d1904699638c94" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual ost::Keydata::~Keydata </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Destroy the keydata object and all allocated memory.
<p>
This may also clear the "cache" file stream if no other keydata objects currently reference it. </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="68af2fafb65d0d583d62c351faca42cd"></a><!-- doxytag: member="ost::Keydata::clrValue" ref="68af2fafb65d0d583d62c351faca42cd" args="(const char *sym)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void ost::Keydata::clrValue </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname1" valign="top" nowrap> <em>sym</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Clear all values associated with a given keyword.
<p>
This does not de-allocate the keyword from memory, however.<p>
<dl compact><dt><b>Returns:</b></dt><dd>keyword name to clear. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="f16246e1f7c5af075493bf37d7e1b48f"></a><!-- doxytag: member="ost::Keydata::end" ref="f16246e1f7c5af075493bf37d7e1b48f" args="(void)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">static void ost::Keydata::end </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
static member to end keydata i/o allocations.
<p>
</td>
</tr>
</table>
<a class="anchor" name="297f5a7239a22576f770b038baac564f"></a><!-- doxytag: member="ost::Keydata::getBool" ref="297f5a7239a22576f770b038baac564f" args="(const char *key)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">bool ost::Keydata::getBool </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname1" valign="top" nowrap> <em>key</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get a bool 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>sym</em> </td><td>keyword name. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>true or false. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="177f94fc01430d2f5e4a79cbbea64b03"></a><!-- doxytag: member="ost::Keydata::getCount" ref="177f94fc01430d2f5e4a79cbbea64b03" args="(void)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">unsigned ost::Keydata::getCount </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get the count of keyword indexes that are actually available so one can allocate a table to receive getIndex.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>number of keywords found. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="5d2ee13740be6e901db41dfb0e0033b6"></a><!-- doxytag: member="ost::Keydata::getCount" ref="5d2ee13740be6e901db41dfb0e0033b6" args="(const char *sym)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">int ost::Keydata::getCount </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname1" valign="top" nowrap> <em>sym</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get a count of the number of data "values" that is associated with a specific keyword.
<p>
Each value is from an accumulation of "<code>load()</code>" requests.<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>sym</em> </td><td>keyword symbol name. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>count of values associated with keyword. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="727c000bb0cbbe8132d676e00e4b7424"></a><!-- doxytag: member="ost::Keydata::getDouble" ref="727c000bb0cbbe8132d676e00e4b7424" args="(const char *key, double def=0.)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">double ost::Keydata::getDouble </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname" nowrap> <em>key</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>double </td>
<td class="mdname" nowrap> <em>def</em> = <code>0.</code></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get a floating 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>sym</em> </td><td>keyword name. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>default</em> </td><td>if not set. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>value of key. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="2412a569a18725e0368f445f4f1cc07a"></a><!-- doxytag: member="ost::Keydata::getFirst" ref="2412a569a18725e0368f445f4f1cc07a" args="(const char *sym)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">const char* ost::Keydata::getFirst </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname1" valign="top" nowrap> <em>sym</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get the first data value for a given keyword.
<p>
This will typically be the <code>/etc</code> set global default.<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>sym</em> </td><td>keyword symbol name. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>first set value for this symbol. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="85b680ae3a530b5261c9e4993365e6cd"></a><!-- doxytag: member="ost::Keydata::getIndex" ref="85b680ae3a530b5261c9e4993365e6cd" args="(char **data, unsigned max)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">unsigned ost::Keydata::getIndex </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">char ** </td>
<td class="mdname" nowrap> <em>data</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>unsigned </td>
<td class="mdname" nowrap> <em>max</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get an index array of ALL keywords that are stored by the current keydata object.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>number of keywords found. </dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>pointer of array to hold keyword strings. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>max</em> </td><td>number of entries the array can hold. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="b2286284aff76cf9e310698ff6f22107"></a><!-- doxytag: member="ost::Keydata::getLast" ref="b2286284aff76cf9e310698ff6f22107" args="(const char *sym)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">const char* ost::Keydata::getLast </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname1" valign="top" nowrap> <em>sym</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get the last (most recently set) value for a given keyword.
<p>
This is typically the value actually used.<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>sym</em> </td><td>keyword symbol name. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>last set value for this symbol. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="ffdaf274202fe5bb12b6dc720f2cb3b7"></a><!-- doxytag: member="ost::Keydata::getList" ref="ffdaf274202fe5bb12b6dc720f2cb3b7" args="(const char *sym)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">const char* const* ost::Keydata::getList </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname1" valign="top" nowrap> <em>sym</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Return a list of all values set for the given keyword returned in order.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>list pointer of array holding all keyword values. </dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>sym</em> </td><td>keyword name to fetch. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="d950a91035be68c3b790dc783d286651"></a><!-- doxytag: member="ost::Keydata::getLong" ref="d950a91035be68c3b790dc783d286651" args="(const char *sym, long def=0)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">long ost::Keydata::getLong </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname" nowrap> <em>sym</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>long </td>
<td class="mdname" nowrap> <em>def</em> = <code>0</code></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get a long value, with an optional default if missing.
<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>sym</em> </td><td>keyword name. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>default</em> </td><td>if not present. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>long value of key. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="7fcd3ce05319e4268064386784a714c5"></a><!-- doxytag: member="ost::Keydata::getString" ref="7fcd3ce05319e4268064386784a714c5" args="(const char *sym, const char *def=NULL)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">const char* ost::Keydata::getString </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname" nowrap> <em>sym</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const char * </td>
<td class="mdname" nowrap> <em>def</em> = <code>NULL</code></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get a string value, with an optional default if missing.
<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>sym</em> </td><td>keyword name. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>default</em> </td><td>if not present. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>string value of key. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="76bcec1ca452d8811d797a7fea2c9e96"></a><!-- doxytag: member="ost::Keydata::getSymbol" ref="76bcec1ca452d8811d797a7fea2c9e96" args="(const char *sym, bool create)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="structost_1_1_keydata_1_1_keysym.html">Keysym</a>* ost::Keydata::getSymbol </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname" nowrap> <em>sym</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>create</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="73ef6b10342042f626b109c24e821b22"></a><!-- doxytag: member="ost::Keydata::isKey" ref="73ef6b10342042f626b109c24e821b22" args="(const char *sym)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">bool ost::Keydata::isKey </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname1" valign="top" nowrap> <em>sym</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Find if a given key exists.
<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>sym</em> </td><td>keyword to find. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>true if exists. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="824f678a4920e40704ae17ef70b47290"></a><!-- doxytag: member="ost::Keydata::load" ref="824f678a4920e40704ae17ef70b47290" args="(Define *pairs)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void ost::Keydata::load </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="structost_1_1_keydata_1_1_define.html">Define</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>pairs</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Load default keywords into the current object.
<p>
This only loads keyword entries which have not already been defined to reduce memory usage. This form of Load is also commonly used in the constructor of a derived <a class="el" href="classost_1_1_keydata.html">Keydata</a> class.<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>pairs</em> </td><td>list of NULL terminated default keyword/value pairs. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="aa445cbcd2cb56f8fab7e3063a55ba24"></a><!-- doxytag: member="ost::Keydata::load" ref="aa445cbcd2cb56f8fab7e3063a55ba24" args="(const char *keypath)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void ost::Keydata::load </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname1" valign="top" nowrap> <em>keypath</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Load additional key values into the currrent object from the specfied config source (a config file/section pair).
<p>
These values will overlay the current keywords when matches are found. This can be used typically in a derived config object class constructor to first load a <code>/etc</code> section, and then load a matching user specific entry from <code>~/.</code> to override default system values with user specific keyword 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>keypath</em> </td><td>(filepath/section) </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="739656231534d299d250d7ac85cb5b52"></a><!-- doxytag: member="ost::Keydata::loadFile" ref="739656231534d299d250d7ac85cb5b52" args="(const char *filepath, const char *keys=NULL, const char *pre=NULL)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void ost::Keydata::loadFile </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname" nowrap> <em>filepath</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const char * </td>
<td class="mdname" nowrap> <em>keys</em> = <code>NULL</code>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const char * </td>
<td class="mdname" nowrap> <em>pre</em> = <code>NULL</code></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Load additional keys into the current object using a real filename that is directly passed rather than a computed key path.
<p>
This also uses a [keys] section as passed to the object.<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>filepath</em> </td><td>to load from </td></tr>
<tr><td valign="top"></td><td valign="top"><em>keys</em> </td><td>section to parse from, or NULL to parse from head </td></tr>
<tr><td valign="top"></td><td valign="top"><em>pre</em> </td><td>optional key prefix </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="d5c9a37238043d8daf932e0fdc9c64e1"></a><!-- doxytag: member="ost::Keydata::loadPrefix" ref="d5c9a37238043d8daf932e0fdc9c64e1" args="(const char *prefix, const char *keypath)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void ost::Keydata::loadPrefix </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname" nowrap> <em>prefix</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const char * </td>
<td class="mdname" nowrap> <em>keypath</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Load additional key values into the currrent object from the specfied config source (a config file/section pair).
<p>
These values will overlay the current keywords when matches are found. This can be used typically in a derived config object class constructor to first load a <code>/etc</code> section, and then load a matching user specific entry from <code>~/.</code> to override default system values with user specific keyword values. This varient puts a prefix in front of the key name.<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>prefix</em> </td><td></td></tr>
<tr><td valign="top"></td><td valign="top"><em>keypath</em> </td><td>(filepath/section) </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="1891928115aa1007abe42d81a695c205"></a><!-- doxytag: member="ost::Keydata::operator[]" ref="1891928115aa1007abe42d81a695c205" args="(const char *keyword)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">const char* ost::Keydata::operator[] </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname1" valign="top" nowrap> <em>keyword</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
A convient notation for accessing the keydata as an associative array of keyword/value pairs through the [] operator.
<p>
</td>
</tr>
</table>
<a class="anchor" name="815ad7e73ec110d57f205f8971972a0c"></a><!-- doxytag: member="ost::Keydata::setValue" ref="815ad7e73ec110d57f205f8971972a0c" args="(const char *sym, const char *data)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void ost::Keydata::setValue </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname" nowrap> <em>sym</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const char * </td>
<td class="mdname" nowrap> <em>data</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Set (replace) the value of a given keyword.
<p>
This new value will become the value returned from <a class="el" href="classost_1_1_keydata.html#b2286284aff76cf9e310698ff6f22107">getLast()</a>, while the prior value will still be stored and found from <code><a class="el" href="classost_1_1_keydata.html#ffdaf274202fe5bb12b6dc720f2cb3b7">getList()</a></code>.<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>sym</em> </td><td>keyword name to set. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>string to store for the keyword. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="5a9b6469b627a674e5e9856707732b29"></a><!-- doxytag: member="ost::Keydata::unlink" ref="5a9b6469b627a674e5e9856707732b29" args="(void)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void ost::Keydata::unlink </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Unlink the keydata object from the cache file stream.
<p>
This should be used if you plan to keepa <a class="el" href="classost_1_1_keydata.html">Keydata</a> object after it is loaded once all keydata objects have been loaded, otherwise the cfgFile stream will remain open. You can also use <a class="el" href="classost_1_1_keydata.html#b2cdccf30c8543716905fbc6dfa29c92">endKeydata()</a>. </td>
</tr>
</table>
<hr><h2>Friends And Related Function Documentation</h2>
<a class="anchor" name="b2cdccf30c8543716905fbc6dfa29c92"></a><!-- doxytag: member="ost::Keydata::endKeydata" ref="b2cdccf30c8543716905fbc6dfa29c92" args="(void)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void endKeydata </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [friend]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Shutdown the file stream cache.
<p>
This should be used before detaching a deamon, <code>exec()</code>, <code>fork()</code>, etc. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="misc_8h-source.html">misc.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Mon Jun 19 10:50:56 2006 for GNU CommonC++ by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2007.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
ad1ba1135a9c9eeffc2e538163e00373
>
files
>
189
