doc/elektra-api/html/group__internal.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
   3 <title>Elektra Projekt: KDB Backends :: Internal Helper for Elektra</title>
   4 <link href="doxygen.css" rel="stylesheet" type="text/css">
   5 <link href="tabs.css" rel="stylesheet" type="text/css">
   6 </head><body>
   7 <!-- Generated by Doxygen 1.5.6 -->
   8 <div class="navigation" id="top">
   9   <div class="tabs">
  10     <ul>
  11       <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
  12       <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  13       <li><a href="modules.html"><span>Modules</span></a></li>
  14     </ul>
  15   </div>
  16 </div>
  17 <div class="contents">
  18 <h1>KDB Backends :: Internal Helper for Elektra</h1>Internal Methods for Elektra and Backends.
  19 <a href="#_details">More...</a><table border="0" cellpadding="0" cellspacing="0">
  20 <tr><td></td></tr>
  21 <tr><td colspan="2"><br><h2>Functions</h2></td></tr>
  22 <tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__internal.html#g18471c9f740ea7988a0e757e752834e6">kdbiStrCaseCmp</a> (const char *s1, const char *s2)</td></tr>
  23
  24 <tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__internal.html#gba2b4284a78cad9cb3ca4cc7291caec5">kdbiRealloc</a> (void **buffer, size_t size)</td></tr>
  25
  26 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__internal.html#g758aca746b4458fd067165c5c46676be">kdbiFree</a> (void *ptr)</td></tr>
  27
  28 <tr><td class="memItemLeft" nowrap align="right" valign="top">char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__internal.html#gc7b7254ccb104b362d3e730da654ea87">kdbiStrDup</a> (const char *s)</td></tr>
  29
  30 <tr><td class="memItemLeft" nowrap align="right" valign="top">size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__internal.html#ga13b38e07d4e54738b951c3e0bef2faf">kdbiStrLen</a> (const char *s)</td></tr>
  31
  32 </table>
  33 <hr><a name="_details"></a><h2>Detailed Description</h2>
  34 Internal Methods for Elektra and Backends.
  35 <p>
  36 To use them: <div class="fragment"><pre class="fragment"><span class="preprocessor"> #include &lt;kdbbackend.h&gt;</span>
  37 </pre></div><p>
  38 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. <hr><h2>Function Documentation</h2>
  39 <a class="anchor" name="g758aca746b4458fd067165c5c46676be"></a><!-- doxytag: member="internal.c::kdbiFree" ref="g758aca746b4458fd067165c5c46676be" args="(void *ptr)" -->
  40 <div class="memitem">
  41 <div class="memproto">
  42       <table class="memname">
  43         <tr>
  44           <td class="memname">void kdbiFree           </td>
  45           <td>(</td>
  46           <td class="paramtype">void *&nbsp;</td>
  47           <td class="paramname"> <em>ptr</em>          </td>
  48           <td>&nbsp;)&nbsp;</td>
  49           <td></td>
  50         </tr>
  51       </table>
  52 </div>
  53 <div class="memdoc">
  54
  55 <p>
  56 Free memory of elektra or its backends.<p>
  57 <dl compact><dt><b>Parameters:</b></dt><dd>
  58   <table border="0" cellspacing="2" cellpadding="0">
  59     <tr><td valign="top"></td><td valign="top"><em>ptr</em>&nbsp;</td><td>the pointer to free</td></tr>
  60   </table>
  61 </dl>
  62 <dl class="see" compact><dt><b>See also:</b></dt><dd>kdbiMalloc </dd></dl>
  63
  64 </div>
  65 </div><p>
  66 <a class="anchor" name="gba2b4284a78cad9cb3ca4cc7291caec5"></a><!-- doxytag: member="internal.c::kdbiRealloc" ref="gba2b4284a78cad9cb3ca4cc7291caec5" args="(void **buffer, size_t size)" -->
  67 <div class="memitem">
  68 <div class="memproto">
  69       <table class="memname">
  70         <tr>
  71           <td class="memname">int kdbiRealloc           </td>
  72           <td>(</td>
  73           <td class="paramtype">void **&nbsp;</td>
  74           <td class="paramname"> <em>buffer</em>, </td>
  75         </tr>
  76         <tr>
  77           <td class="paramkey"></td>
  78           <td></td>
  79           <td class="paramtype">size_t&nbsp;</td>
  80           <td class="paramname"> <em>size</em></td><td>&nbsp;</td>
  81         </tr>
  82         <tr>
  83           <td></td>
  84           <td>)</td>
  85           <td></td><td></td><td></td>
  86         </tr>
  87       </table>
  88 </div>
  89 <div class="memdoc">
  90
  91 <p>
  92 Reallocate Storage in a save way.<p>
  93 <div class="fragment"><pre class="fragment"><span class="keywordflow">if</span> (<a class="code" href="group__internal.html#gba2b4284a78cad9cb3ca4cc7291caec5">kdbiRealloc</a> ((<span class="keywordtype">void</span> **) &amp; buffer, new_length) &lt; 0) {
  94         <span class="comment">// here comes the failure handler</span>
  95         <span class="comment">// you can still use the old buffer</span>
  96 <span class="preprocessor">#if DEBUG</span>
  97 <span class="preprocessor"></span>        fprintf (stderr, <span class="stringliteral">"Reallocation error\n"</span>);
  98 <span class="preprocessor">#endif</span>
  99 <span class="preprocessor"></span>        free (buffer);
 100         buffer = 0;
 101         <span class="comment">// return with error</span>
 102 }
 103  *
 104 </pre></div><p>
 105 <dl compact><dt><b>Parameters:</b></dt><dd>
 106   <table border="0" cellspacing="2" cellpadding="0">
 107     <tr><td valign="top"></td><td valign="top"><em>buffer</em>&nbsp;</td><td>is a pointer to a malloc </td></tr>
 108     <tr><td valign="top"></td><td valign="top"><em>size</em>&nbsp;</td><td>is the new size for the memory </td></tr>
 109   </table>
 110 </dl>
 111 <dl class="return" compact><dt><b>Returns:</b></dt><dd>-1 on failure <p>
 112 0 on success </dd></dl>
 113
 114 </div>
 115 </div><p>
 116 <a class="anchor" name="g18471c9f740ea7988a0e757e752834e6"></a><!-- doxytag: member="internal.c::kdbiStrCaseCmp" ref="g18471c9f740ea7988a0e757e752834e6" args="(const char *s1, const char *s2)" -->
 117 <div class="memitem">
 118 <div class="memproto">
 119       <table class="memname">
 120         <tr>
 121           <td class="memname">int kdbiStrCaseCmp           </td>
 122           <td>(</td>
 123           <td class="paramtype">const char *&nbsp;</td>
 124           <td class="paramname"> <em>s1</em>, </td>
 125         </tr>
 126         <tr>
 127           <td class="paramkey"></td>
 128           <td></td>
 129           <td class="paramtype">const char *&nbsp;</td>
 130           <td class="paramname"> <em>s2</em></td><td>&nbsp;</td>
 131         </tr>
 132         <tr>
 133           <td></td>
 134           <td>)</td>
 135           <td></td><td></td><td></td>
 136         </tr>
 137       </table>
 138 </div>
 139 <div class="memdoc">
 140
 141 <p>
 142 Compare Strings ignoring case.<p>
 143 <dl compact><dt><b>Parameters:</b></dt><dd>
 144   <table border="0" cellspacing="2" cellpadding="0">
 145     <tr><td valign="top"></td><td valign="top"><em>s1</em>&nbsp;</td><td>The first string to be compared </td></tr>
 146     <tr><td valign="top"></td><td valign="top"><em>s2</em>&nbsp;</td><td>The second string to be compared</td></tr>
 147   </table>
 148 </dl>
 149 <dl class="return" compact><dt><b>Returns:</b></dt><dd>a negative number if s1 is less than s2 <p>
 150 0 if s1 matches s2 <p>
 151 a positive number if s1 is greater than s2 </dd></dl>
 152
 153 </div>
 154 </div><p>
 155 <a class="anchor" name="gc7b7254ccb104b362d3e730da654ea87"></a><!-- doxytag: member="internal.c::kdbiStrDup" ref="gc7b7254ccb104b362d3e730da654ea87" args="(const char *s)" -->
 156 <div class="memitem">
 157 <div class="memproto">
 158       <table class="memname">
 159         <tr>
 160           <td class="memname">char* kdbiStrDup           </td>
 161           <td>(</td>
 162           <td class="paramtype">const char *&nbsp;</td>
 163           <td class="paramname"> <em>s</em>          </td>
 164           <td>&nbsp;)&nbsp;</td>
 165           <td></td>
 166         </tr>
 167       </table>
 168 </div>
 169 <div class="memdoc">
 170
 171 <p>
 172 Copy string into new allocated memory.<p>
 173 You need to free the memory yourself.<p>
 174 <dl compact><dt><b>Parameters:</b></dt><dd>
 175   <table border="0" cellspacing="2" cellpadding="0">
 176     <tr><td valign="top"></td><td valign="top"><em>s</em>&nbsp;</td><td>the null-terminated string to duplicate</td></tr>
 177   </table>
 178 </dl>
 179 <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__internal.html#g758aca746b4458fd067165c5c46676be">kdbiFree</a> <p>
 180 <a class="el" href="group__internal.html#ga13b38e07d4e54738b951c3e0bef2faf">kdbiStrLen</a> </dd></dl>
 181
 182 </div>
 183 </div><p>
 184 <a class="anchor" name="ga13b38e07d4e54738b951c3e0bef2faf"></a><!-- doxytag: member="internal.c::kdbiStrLen" ref="ga13b38e07d4e54738b951c3e0bef2faf" args="(const char *s)" -->
 185 <div class="memitem">
 186 <div class="memproto">
 187       <table class="memname">
 188         <tr>
 189           <td class="memname">size_t kdbiStrLen           </td>
 190           <td>(</td>
 191           <td class="paramtype">const char *&nbsp;</td>
 192           <td class="paramname"> <em>s</em>          </td>
 193           <td>&nbsp;)&nbsp;</td>
 194           <td></td>
 195         </tr>
 196       </table>
 197 </div>
 198 <div class="memdoc">
 199
 200 <p>
 201 Calculates the length in bytes of a string.<p>
 202 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#ga13b38e07d4e54738b951c3e0bef2faf">kdbiStrLen()</a> count bytes including the ending NULL.<p>
 203 <dl compact><dt><b>Parameters:</b></dt><dd>
 204   <table border="0" cellspacing="2" cellpadding="0">
 205     <tr><td valign="top"></td><td valign="top"><em>s</em>&nbsp;</td><td>the string to get the length from </td></tr>
 206   </table>
 207 </dl>
 208 <dl class="return" compact><dt><b>Returns:</b></dt><dd>number of bytes used by the string, including the final NULL. </dd></dl>
 209
 210 </div>
 211 </div><p>
 212 </div>
 213 <hr size="1"><address style="text-align: right;"><small>Generated on Tue Jun 30 14:43:54 2009 for Elektra Projekt by&nbsp;
 214 <a href="http://www.doxygen.org/index.html">
 215 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
 216 </body>
 217 </html>