Sophie

Sophie

distrib > Fedora > 14 > x86_64 > media > updates > by-pkgid > 1981b34f021c1f7237fce57ba36850a9 > files > 21

libini_config-devel-0.6.2-5.fc14.x86_64.rpm

<!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>libini_config: Meta data</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.7.4 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">libini_config&#160;<span id="projectnumber">0.1.3</span></div>
  </td>
 </tr>
 </tbody>
</table>
</div>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li id="searchli">
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#groups">Modules</a> &#124;
<a href="#define-members">Defines</a>  </div>
  <div class="headertitle">
<div class="title">Meta data</div>  </div>
<div class="ingroups"><a class="el" href="group__ini__config.html">INI configuration interface</a></div></div>
<div class="contents">
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="groups"></a>
Modules</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__metasection.html">Meta data section names</a></td></tr>
<tr><td colspan="2"><h2><a name="define-members"></a>
Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__metadata.html#gab518ae5583f534716d1af10a48481a16">INI_META_ACTION_NOPARSE</a>&#160;&#160;&#160;0x10000000</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Collect only meta data.  <a href="#gab518ae5583f534716d1af10a48481a16"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<p>Metadata is a collection of a similar structure as any ini file. The difference is that there are some predefined sections and attributes inside these sections. Using meta flags one can specify what section he is interested in including into the meta data. If a flag for a corresponding meta data section is specified the data for this section will be included into the meta data collection. The caller can then use meta data collection to get items from it and then get a specific value using a corresponding conversion function.</p>
<p>Think about the meta data as an INI file that looks like this:</p>
<p><b> [ACCESS]</p>
<ul>
<li>uid = <em>&lt;ini file owner uid&gt;</em></li>
<li>gid = <em>&lt;ini file group gid&gt;</em></li>
<li>perm = <em>&lt;permissions word&gt;</em></li>
<li>name = <em>&lt;file name&gt;</em></li>
<li>created = <em>&lt;time stamp&gt;</em></li>
<li>modified = <em>&lt;time stamp&gt;</em></li>
<li>...</li>
</ul>
<p></b></p>
<p><b> [ERROR]</p>
<ul>
<li>read_error = <em>&lt;file open error if any&gt;</em></li>
<li>...</li>
</ul>
<p></b></p>
<p><b> [<em>TBD</em>]</p>
<ul>
<li>...</li>
</ul>
<p></b></p>
<p><b> </b></p>
<p>The names of the keys and sections provide an example of how the meta data is structured. Look information about specific sections and available keys in this manual to get the exact set of currently supported sections and keys. </p>
<hr/><h2>Define Documentation</h2>
<a class="anchor" id="gab518ae5583f534716d1af10a48481a16"></a><!-- doxytag: member="ini_config.h::INI_META_ACTION_NOPARSE" ref="gab518ae5583f534716d1af10a48481a16" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define INI_META_ACTION_NOPARSE&#160;&#160;&#160;0x10000000</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Collect only meta data. </p>
<p>Special flag that indicates that only meta data needs to be collected. No parsing should be performed. </p>

</div>
</div>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a></div>

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

<hr class="footer"/><address class="footer"><small>Generated on Thu Sep 15 2011 for libini_config by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>