Sophie

Sophie

distrib > Fedora > 13 > x86_64 > by-pkgid > 1f68756f2311732dff7a7e2ea2a48123 > files > 29

elektra-devel-0.7.0-3.fc13.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>Elektra Projekt: KDB Backends :: Internal Helper for Elektra</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.1 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>KDB Backends :: Internal Helper for Elektra</h1>
<p>Internal Methods for Elektra and Backends.  
<a href="#_details">More...</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__internal.html#ga18471c9f740ea7988a0e757e752834e6">kdbiStrCaseCmp</a> (const char *s1, const char *s2)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__internal.html#gaba2b4284a78cad9cb3ca4cc7291caec5">kdbiRealloc</a> (void **buffer, size_t size)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__internal.html#ga758aca746b4458fd067165c5c46676be">kdbiFree</a> (void *ptr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__internal.html#gac7b7254ccb104b362d3e730da654ea87">kdbiStrDup</a> (const char *s)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__internal.html#gaa13b38e07d4e54738b951c3e0bef2faf">kdbiStrLen</a> (const char *s)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Internal Methods for Elektra and Backends. </p>
<p>To use them: </p>
<div class="fragment"><pre class="fragment"><span class="preprocessor"> #include &lt;kdbbackend.h&gt;</span>
</pre></div><p>There are some areas where libraries have to reimplement some basic functions to archive support for non-standard systems, for testing purposes or to provide a little more convenience. </p>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga758aca746b4458fd067165c5c46676be"></a><!-- doxytag: member="internal.c::kdbiFree" ref="ga758aca746b4458fd067165c5c46676be" args="(void *ptr)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void kdbiFree </td>
          <td>(</td>
          <td class="paramtype">void *&nbsp;</td>
          <td class="paramname"> <em>ptr</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Free memory of elektra or its backends.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>ptr</em>&nbsp;</td><td>the pointer to free</td></tr>
  </table>
  </dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd>kdbiMalloc </dd></dl>

</div>
</div>
<a class="anchor" id="gaba2b4284a78cad9cb3ca4cc7291caec5"></a><!-- doxytag: member="internal.c::kdbiRealloc" ref="gaba2b4284a78cad9cb3ca4cc7291caec5" args="(void **buffer, size_t size)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int kdbiRealloc </td>
          <td>(</td>
          <td class="paramtype">void **&nbsp;</td>
          <td class="paramname"> <em>buffer</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&nbsp;</td>
          <td class="paramname"> <em>size</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Reallocate Storage in a save way.</p>
<div class="fragment"><pre class="fragment"><span class="keywordflow">if</span> (<a class="code" href="group__internal.html#gaba2b4284a78cad9cb3ca4cc7291caec5">kdbiRealloc</a> ((<span class="keywordtype">void</span> **) &amp; buffer, new_length) &lt; 0) {
        <span class="comment">// here comes the failure handler</span>
        <span class="comment">// you can still use the old buffer</span>
<span class="preprocessor">#if DEBUG</span>
<span class="preprocessor"></span>        fprintf (stderr, <span class="stringliteral">&quot;Reallocation error\n&quot;</span>);
<span class="preprocessor">#endif</span>
<span class="preprocessor"></span>        free (buffer);
        buffer = 0;
        <span class="comment">// return with error</span>
}
 *
</pre></div><dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>buffer</em>&nbsp;</td><td>is a pointer to a malloc </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>size</em>&nbsp;</td><td>is the new size for the memory </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>-1 on failure </dd>
<dd>
0 on success </dd></dl>

</div>
</div>
<a class="anchor" id="ga18471c9f740ea7988a0e757e752834e6"></a><!-- doxytag: member="internal.c::kdbiStrCaseCmp" ref="ga18471c9f740ea7988a0e757e752834e6" args="(const char *s1, const char *s2)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int kdbiStrCaseCmp </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>s1</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>s2</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Compare Strings ignoring case.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>s1</em>&nbsp;</td><td>The first string to be compared </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>s2</em>&nbsp;</td><td>The second string to be compared</td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a negative number if s1 is less than s2 </dd>
<dd>
0 if s1 matches s2 </dd>
<dd>
a positive number if s1 is greater than s2 </dd></dl>

</div>
</div>
<a class="anchor" id="gac7b7254ccb104b362d3e730da654ea87"></a><!-- doxytag: member="internal.c::kdbiStrDup" ref="gac7b7254ccb104b362d3e730da654ea87" args="(const char *s)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">char* kdbiStrDup </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>s</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Copy string into new allocated memory.</p>
<p>You need to free the memory yourself.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>s</em>&nbsp;</td><td>the null-terminated string to duplicate</td></tr>
  </table>
  </dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__internal.html#ga758aca746b4458fd067165c5c46676be">kdbiFree</a> </dd>
<dd>
<a class="el" href="group__internal.html#gaa13b38e07d4e54738b951c3e0bef2faf">kdbiStrLen</a> </dd></dl>

</div>
</div>
<a class="anchor" id="gaa13b38e07d4e54738b951c3e0bef2faf"></a><!-- doxytag: member="internal.c::kdbiStrLen" ref="gaa13b38e07d4e54738b951c3e0bef2faf" args="(const char *s)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">size_t kdbiStrLen </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>s</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Calculates the length in bytes of a string.</p>
<p>This function differs from strlen() because it is Unicode and multibyte chars safe. While strlen() counts characters and ignores the final NULL, <a class="el" href="group__internal.html#gaa13b38e07d4e54738b951c3e0bef2faf">kdbiStrLen()</a> count bytes including the ending NULL.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>s</em>&nbsp;</td><td>the string to get the length from </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>number of bytes used by the string, including the final NULL. </dd></dl>

</div>
</div>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on 8 Nov 2009 for Elektra Projekt by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>