libs/dbprim/doc/html/group__dbprim__key.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
   2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
   3 <title>Database keys</title>
   4 <link href="doxygen.css" rel="stylesheet" type="text/css">
   5 </head><body bgcolor="#ffffff">
   6 <!-- Generated by Doxygen 1.2.8.1 -->
   7 <center>
   8 <a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="modules.html">Modules</a> &nbsp; </center>
   9 <hr><h1>Database keys</h1><table border=0 cellpadding=0 cellspacing=0>
  10 <tr><td colspan=2><br><h2>Defines</h2></td></tr>
  11 <tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="group__dbprim__key.html#a1">DB_KEY_INIT</a>(key, size)</td></tr>
  12 <tr><td>&nbsp;</td><td><font size=-1><em>Database key static initializer.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr>
  13 <tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="group__dbprim__key.html#a2">dk_key</a>(key)</td></tr>
  14 <tr><td>&nbsp;</td><td><font size=-1><em>Database key accessor macro.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr>
  15 <tr><td nowrap align=right valign=top>#define&nbsp;</td><td valign=bottom><a class="el" href="group__dbprim__key.html#a3">dk_len</a>(key)</td></tr>
  16 <tr><td>&nbsp;</td><td><font size=-1><em>Database key length accessor macro.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr>
  17 <tr><td colspan=2><br><h2>Typedefs</h2></td></tr>
  18 <tr><td nowrap align=right valign=top>typedef struct _db_key_s&nbsp;</td><td valign=bottom><a class="el" href="group__dbprim__key.html#a0">db_key_t</a></td></tr>
  19 <tr><td>&nbsp;</td><td><font size=-1><em>Database key.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr>
  20 </table>
  21 <hr><a name="_details"></a><h2>Detailed Description</h2>
  22 This module contains interfaces common to all database modules--mainly the macros concerned with manipulating database keys and the definition of the key structure.
  23 <p>
  24 The key may be any arbitrary pointer, including a pointer to a string. Everything that handles a key either copies the contents of the <a class="el" href="group__dbprim__key.html#a0">db_key_t</a> structure or passes it to a user-defined function. If required, as in the case of a string, a length may also be represented in the key structure. <hr><h2>Define Documentation</h2>
  25 <a name="a1" doxytag="dbprim.h.top::DB_KEY_INIT"></a><p>
  26 <table width="100%" cellpadding="2" cellspacing="0" border="0">
  27   <tr>
  28     <td class="md">
  29       <table cellpadding="0" cellspacing="0" border="0">
  30         <tr>
  31           <td nowrap valign="top"><b>
  32 #define DB_KEY_INIT(
  33           </b></td>
  34           <td valign="bottom"><b>
  35 key, size&nbsp;)
  36       </table>
  37     </td>
  38   </tr>
  39 </table>
  40 <table cellspacing=5 cellpadding=0 border=0>
  41   <tr>
  42     <td>
  43       &nbsp;
  44     </td>
  45     <td>
  46
  47 <p>
  48
  49 <p>
  50  This macro allows a <a class="el" href="group__dbprim__key.html#a0">db_key_t</a> to be initialized statically.<dl compact><dt>
  51 <b>Parameters: </b><dd>
  52 <table border=0 cellspacing=2 cellpadding=0>
  53 <tr><td valign=top><em>key</em>
  54 &nbsp;</td><td>
  55 A pointer to the key. </td></tr>
  56 <tr><td valign=top><em>size</em>
  57 &nbsp;</td><td>
  58 Size of the key. </td></tr>
  59 </table>
  60 </dl>    </td>
  61   </tr>
  62 </table>
  63 <a name="a2" doxytag="dbprim.h.top::dk_key"></a><p>
  64 <table width="100%" cellpadding="2" cellspacing="0" border="0">
  65   <tr>
  66     <td class="md">
  67       <table cellpadding="0" cellspacing="0" border="0">
  68         <tr>
  69           <td nowrap valign="top"><b>
  70 #define dk_key(
  71           </b></td>
  72           <td valign="bottom"><b>
  73 key&nbsp;)
  74       </table>
  75     </td>
  76   </tr>
  77 </table>
  78 <table cellspacing=5 cellpadding=0 border=0>
  79   <tr>
  80     <td>
  81       &nbsp;
  82     </td>
  83     <td>
  84
  85 <p>
  86
  87 <p>
  88  This macro allows access to the key field of a <a class="el" href="group__dbprim__key.html#a0">db_key_t</a>. It may be used as an lvalue in order to assign a key to a <a class="el" href="group__dbprim__key.html#a0">db_key_t</a>.<dl compact><dt>
  89 <b>Parameters: </b><dd>
  90 <table border=0 cellspacing=2 cellpadding=0>
  91 <tr><td valign=top><em>key</em>
  92 &nbsp;</td><td>
  93 A pointer to a <a class="el" href="group__dbprim__key.html#a0">db_key_t</a>. </td></tr>
  94 </table>
  95 </dl><dl compact><dt>
  96 <b>Returns: </b><dd>
  97 A pointer to a key (<code>void *</code>). </dl>    </td>
  98   </tr>
  99 </table>
 100 <a name="a3" doxytag="dbprim.h.top::dk_len"></a><p>
 101 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 102   <tr>
 103     <td class="md">
 104       <table cellpadding="0" cellspacing="0" border="0">
 105         <tr>
 106           <td nowrap valign="top"><b>
 107 #define dk_len(
 108           </b></td>
 109           <td valign="bottom"><b>
 110 key&nbsp;)
 111       </table>
 112     </td>
 113   </tr>
 114 </table>
 115 <table cellspacing=5 cellpadding=0 border=0>
 116   <tr>
 117     <td>
 118       &nbsp;
 119     </td>
 120     <td>
 121
 122 <p>
 123
 124 <p>
 125  This macro allows access to the key length field of a <a class="el" href="group__dbprim__key.html#a0">db_key_t</a>. It may be used as an lvalue in order to assign a length to a <a class="el" href="group__dbprim__key.html#a0">db_key_t</a>.<dl compact><dt>
 126 <b>Parameters: </b><dd>
 127 <table border=0 cellspacing=2 cellpadding=0>
 128 <tr><td valign=top><em>key</em>
 129 &nbsp;</td><td>
 130 A pointer to a <a class="el" href="group__dbprim__key.html#a0">db_key_t</a>. </td></tr>
 131 </table>
 132 </dl><dl compact><dt>
 133 <b>Returns: </b><dd>
 134 An <code>int</code> describing the length of the key. </dl>    </td>
 135   </tr>
 136 </table>
 137 <hr><h2>Typedef Documentation</h2>
 138 <a name="a0" doxytag="dbprim.h.top::db_key_t"></a><p>
 139 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 140   <tr>
 141     <td class="md">
 142       <table cellpadding="0" cellspacing="0" border="0">
 143         <tr>
 144           <td nowrap valign="top"><b>
 145 typedef struct _db_key_s db_key_t
 146           </b></td>
 147         </tr>
 148
 149       </table>
 150     </td>
 151   </tr>
 152 </table>
 153 <table cellspacing=5 cellpadding=0 border=0>
 154   <tr>
 155     <td>
 156       &nbsp;
 157     </td>
 158     <td>
 159
 160 <p>
 161
 162 <p>
 163  This structure is a generic key containing a void * pointer and a length parameter. It should be accessed with * <a class="el" href="group__dbprim__key.html#a2">dk_key</a>() and <a class="el" href="group__dbprim__key.html#a3">dk_len</a>().     </td>
 164   </tr>
 165 </table>
 166 <hr><address><small>Generated at Thu Mar 6 21:23:10 2003 for dbprim by
 167 <a href="http://www.doxygen.org/index.html">
 168 <img src="doxygen.gif" alt="doxygen" align="middle" border=0
 169 width=110 height=53></a>1.2.8.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>,
 170  &copy;&nbsp;1997-2001</small></address>
 171 </body>
 172 </html>