Sophie

Sophie

distrib > Mandriva > 8.2 > i586 > media > contrib > by-pkgid > 68d373e54fb21da3730c08bede406633 > files > 237

libCommonC++1.9_3-devel-1.9.4-2mdk.i586.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Keydata class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body bgcolor="#ffffff">
<!-- Generated by Doxygen 1.2.10 -->
<center>
<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>Keydata  Class Reference</h1>Keydata 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 &lt;<a class="el" href="misc_8h-source.html">misc.h</a>&gt;</code>
<p>
<p>Inheritance diagram for Keydata::
<p><center><img src="class_keydata.gif" usemap="#Keydata_map" border="0"></center>
<map name="Keydata_map">
<area href="class_mem_pager.html" alt="MemPager" shape="rect" coords="0,0,73,24">
</map>
<a href="class_keydata-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="class_keydata.html#a0">CCXX_MEMBER_EXPORT</a> (CCXX_EMPTY) Keydata()</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Create an empty key data object.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="class_keydata.html#a1">CCXX_MEMBER_EXPORT</a> (CCXX_EMPTY) Keydata(const char *keypath, const char *environment="CONFIG_KEYDATA")</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Create a new key data object and use "Load" method to load an initial config file section into it.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="class_keydata.html#a2">CCXX_MEMBER_EXPORT</a> (virtual)~Keydata()</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Destroy the keydata object and all allocated memory.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="class_keydata.html#a3">CCXX_MEMBER_EXPORT</a> (void) Unlink(void)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Unlink the keydata object from the cache file stream.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="class_keydata.html#a4">CCXX_MEMBER_EXPORT</a> (int) getCount(const char *sym)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Get a count of the number of data "values" that is associated with a specific keyword.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="class_keydata.html#a5">CCXX_MEMBER_EXPORT</a> (const char *) getFirst(const char *sym)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Get the first data value for a given keyword.</em> <a href="#a5">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="class_keydata.html#a6">CCXX_MEMBER_EXPORT</a> (const char *) getLast(const char *sym)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Get the last (most recently set) value for a given keyword.</em> <a href="#a6">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="class_keydata.html#a7">CCXX_MEMBER_EXPORT</a> (int) getIndex(char **data, int max)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Get an index array of ALL keywords that are stored by the current keydata object.</em> <a href="#a7">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="class_keydata.html#a8">CCXX_MEMBER_EXPORT</a> (void) setValue(const char *sym, const char *data)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Set (replace) the value of a given keyword.</em> <a href="#a8">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="class_keydata.html#a9">CCXX_MEMBER_EXPORT</a> (const char *const *) getList(const char *sym)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Return a list of all values set for the given keyword returned in order.</em> <a href="#a9">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="class_keydata.html#a10">CCXX_MEMBER_EXPORT</a> (void) clrValue(const char *sym)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Clear all values associated with a given keyword.</em> <a href="#a10">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>const char *&nbsp;</td><td valign=bottom><a class="el" href="class_keydata.html#a11">operator[]</a> (const char *keyword)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>A convient notation for accessing the keydata as an associative array of keyword/value pairs through the [] operator.</em> <a href="#a11">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>friend&nbsp;</td><td valign=bottom><a class="el" href="class_keydata.html#a12">CCXX_EXPORT</a> (void) endKeydata(void)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Shutdown the file stream cache.</em> <a href="#a12">More...</a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr>
<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="class_keydata.html#b0">CCXX_MEMBER_EXPORT</a> (<a class="el" href="misc_8h.html#a4">keysym_t</a> *) getSymbol(const char *sym, bool create)</td></tr>
<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="class_keydata.html#b1">CCXX_MEMBER_EXPORT</a> (void) Load(const char *keypath, const char *environment="CONFIG_KEYDATA")</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Load additional key values into the currrent object from the specfied config source (a config file/section pair).</em> <a href="#b1">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="class_keydata.html#b2">CCXX_MEMBER_EXPORT</a> (void) Load(<a class="el" href="struct_k_e_y_d_e_f.html">KEYDEF</a> *pairs)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Load default keywords into the current object.</em> <a href="#b2">More...</a><em></em></font><br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Keydata 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>
Keydata 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>
Keydata 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 Keydata
 {
   public:
     KeyPaths() : Keydata("/server/paths")
     {
       static <a class="el" href="struct_k_e_y_d_e_f.html">KEYDEF</a> *defvalues = {
 	  {"datafiles", "/var/server"},
 	  {NULL, NULL}};
 
       // override with [paths] from "~/.serverrc" if avail.
 
       Load("~server/paths");
       Load(defvalues);
     }
 };
 
 KeyPaths keypaths;
 </pre></code>
<p>
<dl compact><dt><b>
Author: </b><dd>
David Sugar &lt;<a href="mailto:dyfet@ostel.com">dyfet@ostel.com</a>&gt; </dl>
<p>
<hr><h2>Member Function Documentation</h2>
<a name="a12" doxytag="Keydata::CCXX_EXPORT"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> Keydata::CCXX_EXPORT </td>
          <td class="md">(&nbsp;</td>
          <td class="md">void</td>
          <td class="mdname1">&nbsp;          </td>
          <td class="md">)&nbsp;</td>
          <td class="md"></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </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>
<a name="a10" doxytag="Keydata::CCXX_MEMBER_EXPORT"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> Keydata::CCXX_MEMBER_EXPORT </td>
          <td class="md">(&nbsp;</td>
          <td class="md">void</td>
          <td class="mdname1">&nbsp;          </td>
          <td class="md">)&nbsp;</td>
          <td class="md"> const</td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </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><dd>
keyword name to clear. </dl>    </td>
  </tr>
</table>
<a name="a9" doxytag="Keydata::CCXX_MEMBER_EXPORT"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> Keydata::CCXX_MEMBER_EXPORT </td>
          <td class="md">(&nbsp;</td>
          <td class="md">const char *const *</td>
          <td class="mdname1">&nbsp;          </td>
          <td class="md">)&nbsp;</td>
          <td class="md"> const</td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Return a list of all values set for the given keyword returned in order.
<p>
<dl compact><dt><b>
Returns: </b><dd>
list pointer of array holding all keyword values. </dl><dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>keyword
</em>&nbsp;</td><td>
name to fetch. </td></tr>
</table>
</dl>    </td>
  </tr>
</table>
<a name="a8" doxytag="Keydata::CCXX_MEMBER_EXPORT"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> Keydata::CCXX_MEMBER_EXPORT </td>
          <td class="md">(&nbsp;</td>
          <td class="md">void</td>
          <td class="mdname1">&nbsp;          </td>
          <td class="md">)&nbsp;</td>
          <td class="md"> const</td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Set (replace) the value of a given keyword.
<p>
This new value will become the value returned from getLast(), while the prior value will still be stored and found from <code>getList()</code>.<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>keyword
</em>&nbsp;</td><td>
name to set. </td></tr>
<tr><td valign=top><em>data
</em>&nbsp;</td><td>
string to store for the keyword. </td></tr>
</table>
</dl>    </td>
  </tr>
</table>
<a name="a7" doxytag="Keydata::CCXX_MEMBER_EXPORT"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> Keydata::CCXX_MEMBER_EXPORT </td>
          <td class="md">(&nbsp;</td>
          <td class="md">int</td>
          <td class="mdname1">&nbsp;          </td>
          <td class="md">)&nbsp;</td>
          <td class="md"></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </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><dd>
number of keywords found. </dl><dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>data
</em>&nbsp;</td><td>
pointer of array to hold keyword strings. </td></tr>
<tr><td valign=top><em>max
</em>&nbsp;</td><td>
number of entries the array can hold. </td></tr>
</table>
</dl>    </td>
  </tr>
</table>
<a name="a6" doxytag="Keydata::CCXX_MEMBER_EXPORT"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> Keydata::CCXX_MEMBER_EXPORT </td>
          <td class="md">(&nbsp;</td>
          <td class="md">const char *</td>
          <td class="mdname1">&nbsp;          </td>
          <td class="md">)&nbsp;</td>
          <td class="md"> const</td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Get the last (most recently set) value for a given keyword.
<p>
This is typically the value actually used.<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>keywork
</em>&nbsp;</td><td>
symbol name. </td></tr>
</table>
</dl><dl compact><dt><b>
Returns: </b><dd>
last set value for this symbol. </dl>    </td>
  </tr>
</table>
<a name="a5" doxytag="Keydata::CCXX_MEMBER_EXPORT"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> Keydata::CCXX_MEMBER_EXPORT </td>
          <td class="md">(&nbsp;</td>
          <td class="md">const char *</td>
          <td class="mdname1">&nbsp;          </td>
          <td class="md">)&nbsp;</td>
          <td class="md"> const</td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Get the first data value for a given keyword.
<p>
This will typically be the <code>/etc</code> set global default.<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>keyword
</em>&nbsp;</td><td>
symbol name. </td></tr>
</table>
</dl><dl compact><dt><b>
Returns: </b><dd>
first set value for this symbol. </dl>    </td>
  </tr>
</table>
<a name="a4" doxytag="Keydata::CCXX_MEMBER_EXPORT"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> Keydata::CCXX_MEMBER_EXPORT </td>
          <td class="md">(&nbsp;</td>
          <td class="md">int</td>
          <td class="mdname1">&nbsp;          </td>
          <td class="md">)&nbsp;</td>
          <td class="md"> const</td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </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.<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>keyword
</em>&nbsp;</td><td>
symbol name. </td></tr>
</table>
</dl><dl compact><dt><b>
Returns: </b><dd>
count of values associated with keyword. </dl>    </td>
  </tr>
</table>
<a name="a3" doxytag="Keydata::CCXX_MEMBER_EXPORT"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> Keydata::CCXX_MEMBER_EXPORT </td>
          <td class="md">(&nbsp;</td>
          <td class="md">void</td>
          <td class="mdname1">&nbsp;          </td>
          <td class="md">)&nbsp;</td>
          <td class="md"></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Unlink the keydata object from the cache file stream.
<p>
This should be used if you plan to keepa Keydata object after it is loaded once all keydata objects have been loaded, otherwise the cfgFile stream will remain open. You can also use endKeydata().     </td>
  </tr>
</table>
<a name="a2" doxytag="Keydata::CCXX_MEMBER_EXPORT"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> Keydata::CCXX_MEMBER_EXPORT </td>
          <td class="md">(&nbsp;</td>
          <td class="md">virtual</td>
          <td class="mdname1">&nbsp;          </td>
          <td class="md">)&nbsp;</td>
          <td class="md"></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </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>
<a name="a1" doxytag="Keydata::CCXX_MEMBER_EXPORT"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> Keydata::CCXX_MEMBER_EXPORT </td>
          <td class="md">(&nbsp;</td>
          <td class="md">CCXX_EMPTY</td>
          <td class="mdname1">&nbsp;          </td>
          <td class="md">)&nbsp;</td>
          <td class="md"> const</td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </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><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>keypath
</em>&nbsp;</td><td>
(filepath/section) </td></tr>
</table>
</dl>    </td>
  </tr>
</table>
<a name="a0" doxytag="Keydata::CCXX_MEMBER_EXPORT"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> Keydata::CCXX_MEMBER_EXPORT </td>
          <td class="md">(&nbsp;</td>
          <td class="md">CCXX_EMPTY</td>
          <td class="mdname1">&nbsp;          </td>
          <td class="md">)&nbsp;</td>
          <td class="md"></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Create an empty key data object.
<p>
    </td>
  </tr>
</table>
<a name="b2" doxytag="Keydata::CCXX_MEMBER_EXPORT"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> Keydata::CCXX_MEMBER_EXPORT </td>
          <td class="md">(&nbsp;</td>
          <td class="md">void</td>
          <td class="mdname1">&nbsp;          </td>
          <td class="md">)&nbsp;</td>
          <td class="md"><code> [protected]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </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 Keydata class.<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>list
</em>&nbsp;</td><td>
of NULL terminated default keyword/value pairs. </td></tr>
</table>
</dl>    </td>
  </tr>
</table>
<a name="b1" doxytag="Keydata::CCXX_MEMBER_EXPORT"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> Keydata::CCXX_MEMBER_EXPORT </td>
          <td class="md">(&nbsp;</td>
          <td class="md">void</td>
          <td class="mdname1">&nbsp;          </td>
          <td class="md">)&nbsp;</td>
          <td class="md"> const<code> [protected]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </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.<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>keypath
</em>&nbsp;</td><td>
(filepath/section) </td></tr>
</table>
</dl>    </td>
  </tr>
</table>
<a name="b0" doxytag="Keydata::CCXX_MEMBER_EXPORT"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> Keydata::CCXX_MEMBER_EXPORT </td>
          <td class="md">(&nbsp;</td>
          <td class="md"><a class="el" href="misc_8h.html#a4">keysym_t</a> *</td>
          <td class="mdname1">&nbsp;          </td>
          <td class="md">)&nbsp;</td>
          <td class="md"> const<code> [protected]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
    </td>
  </tr>
</table>
<a name="a11" doxytag="Keydata::operator[]"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> const char* Keydata::operator[] </td>
          <td class="md">(&nbsp;</td>
          <td class="md">const char *</td>
          <td class="mdname1">&nbsp; <em>keyword</em>          </td>
          <td class="md">)&nbsp;</td>
          <td class="md"><code> [inline]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </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>
<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><address><small>Generated at Tue Nov 20 13:28:48 2001 for CommonC++ by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.gif" alt="doxygen" align="middle" border=0 
width=110 height=53></a>1.2.10 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>,
 &copy;&nbsp;1997-2001</small></address>
</body>
</html>