| 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 Primitives</title> |
| 4 |
<link href="doxygen.css" rel="stylesheet" type="text/css"> |
| 5 |
</head><body> |
| 6 |
<!-- Generated by Doxygen 1.2.18 --> |
| 7 |
<center> |
| 8 |
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="modules.html">Modules</a> </center> |
| 9 |
<hr><h1>Database Primitives</h1><hr><a name="_details"></a><h2>Detailed Description</h2> |
| 10 |
This module describes interfaces common to all database modules--mainly the macros concerned with manipulating database keys and the definition of the key structure. |
| 11 |
<p> |
| 12 |
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.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. <table border=0 cellpadding=0 cellspacing=0> |
| 13 |
<tr><td></td></tr> |
| 14 |
<tr><td colspan=2><br><h2>Defines</h2></td></tr> |
| 15 |
<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__dbprim.html#a1">DB_KEY_INIT</a>(key, size)</td></tr> |
| 16 |
<tr><td> </td><td><font size=-1><em>Database key static initializer.</em> <a href="#a1"></a><em></em></font><br><br></td></tr> |
| 17 |
<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__dbprim.html#a2">dk_key</a>(key)</td></tr> |
| 18 |
<tr><td> </td><td><font size=-1><em>Database key accessor macro.</em> <a href="#a2"></a><em></em></font><br><br></td></tr> |
| 19 |
<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__dbprim.html#a3">dk_len</a>(key)</td></tr> |
| 20 |
<tr><td> </td><td><font size=-1><em>Database key length accessor macro.</em> <a href="#a3"></a><em></em></font><br><br></td></tr> |
| 21 |
<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__dbprim.html#a4">DB_FLAG_REVERSE</a></td></tr> |
| 22 |
<tr><td> </td><td><font size=-1><em>Reverse flag.</em> <a href="#a4"></a><em></em></font><br><br></td></tr> |
| 23 |
<tr><td colspan=2><br><h2>Typedefs</h2></td></tr> |
| 24 |
<tr><td nowrap align=right valign=top>typedef _db_key_s </td><td valign=bottom><a class="el" href="group__dbprim.html#a0">db_key_t</a></td></tr> |
| 25 |
<tr><td> </td><td><font size=-1><em>Database key.</em> <a href="#a0"></a><em></em></font><br><br></td></tr> |
| 26 |
</table> |
| 27 |
<hr><h2>Define Documentation</h2> |
| 28 |
<a name="a4" doxytag="dbprim.h::DB_FLAG_REVERSE"></a><p> |
| 29 |
<table width="100%" cellpadding="2" cellspacing="0" border="0"> |
| 30 |
<tr> |
| 31 |
<td class="md"> |
| 32 |
<table cellpadding="0" cellspacing="0" border="0"> |
| 33 |
<tr> |
| 34 |
<td class="md" nowrap valign="top"> #define DB_FLAG_REVERSE |
| 35 |
</table> |
| 36 |
</td> |
| 37 |
</tr> |
| 38 |
</table> |
| 39 |
<table cellspacing=5 cellpadding=0 border=0> |
| 40 |
<tr> |
| 41 |
<td> |
| 42 |
|
| 43 |
</td> |
| 44 |
<td> |
| 45 |
|
| 46 |
<p> |
| 47 |
This flag can be passed to ordered iterations to reverse the order of the iterations. </td> |
| 48 |
</tr> |
| 49 |
</table> |
| 50 |
<a name="a1" doxytag="dbprim.h::DB_KEY_INIT"></a><p> |
| 51 |
<table width="100%" cellpadding="2" cellspacing="0" border="0"> |
| 52 |
<tr> |
| 53 |
<td class="md"> |
| 54 |
<table cellpadding="0" cellspacing="0" border="0"> |
| 55 |
<tr> |
| 56 |
<td class="md" nowrap valign="top"> #define DB_KEY_INIT</td> |
| 57 |
<td class="md" valign="top">( </td> |
| 58 |
<td class="md" nowrap valign="top">key, <tr> |
| 59 |
<td></td> |
| 60 |
<td></td> |
| 61 |
<td class="md" nowrap>size </td> |
| 62 |
<td class="mdname1" valign="top" nowrap> </td> |
| 63 |
<td class="md" valign="top">) </td> |
| 64 |
<td class="md" nowrap> |
| 65 |
</table> |
| 66 |
</td> |
| 67 |
</tr> |
| 68 |
</table> |
| 69 |
<table cellspacing=5 cellpadding=0 border=0> |
| 70 |
<tr> |
| 71 |
<td> |
| 72 |
|
| 73 |
</td> |
| 74 |
<td> |
| 75 |
|
| 76 |
<p> |
| 77 |
This macro allows a <a class="el" href="group__dbprim.html#a0">db_key_t</a> to be initialized statically.<dl compact><dt><b>Parameters: </b></dt><dd> |
| 78 |
<table border=0 cellspacing=2 cellpadding=0> |
| 79 |
<tr><td valign=top><em>key</em> </td><td> |
| 80 |
A pointer to the key. </td></tr> |
| 81 |
<tr><td valign=top><em>size</em> </td><td> |
| 82 |
Size of the key. </td></tr> |
| 83 |
</table> |
| 84 |
</dl> </td> |
| 85 |
</tr> |
| 86 |
</table> |
| 87 |
<a name="a2" doxytag="dbprim.h::dk_key"></a><p> |
| 88 |
<table width="100%" cellpadding="2" cellspacing="0" border="0"> |
| 89 |
<tr> |
| 90 |
<td class="md"> |
| 91 |
<table cellpadding="0" cellspacing="0" border="0"> |
| 92 |
<tr> |
| 93 |
<td class="md" nowrap valign="top"> #define dk_key</td> |
| 94 |
<td class="md" valign="top">( </td> |
| 95 |
<td class="md" nowrap valign="top">key </td> |
| 96 |
<td class="mdname1" valign="top" nowrap> </td> |
| 97 |
<td class="md" valign="top">) </td> |
| 98 |
<td class="md" nowrap> |
| 99 |
</table> |
| 100 |
</td> |
| 101 |
</tr> |
| 102 |
</table> |
| 103 |
<table cellspacing=5 cellpadding=0 border=0> |
| 104 |
<tr> |
| 105 |
<td> |
| 106 |
|
| 107 |
</td> |
| 108 |
<td> |
| 109 |
|
| 110 |
<p> |
| 111 |
This macro allows access to the key field of a <a class="el" href="group__dbprim.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.html#a0">db_key_t</a>.<dl compact><dt><b>Parameters: </b></dt><dd> |
| 112 |
<table border=0 cellspacing=2 cellpadding=0> |
| 113 |
<tr><td valign=top><em>key</em> </td><td> |
| 114 |
A pointer to a <a class="el" href="group__dbprim.html#a0">db_key_t</a>. </td></tr> |
| 115 |
</table> |
| 116 |
</dl><dl compact><dt><b>Returns: </b></dt><dd> |
| 117 |
A pointer to a key (<code>void *</code>). </dl> </td> |
| 118 |
</tr> |
| 119 |
</table> |
| 120 |
<a name="a3" doxytag="dbprim.h::dk_len"></a><p> |
| 121 |
<table width="100%" cellpadding="2" cellspacing="0" border="0"> |
| 122 |
<tr> |
| 123 |
<td class="md"> |
| 124 |
<table cellpadding="0" cellspacing="0" border="0"> |
| 125 |
<tr> |
| 126 |
<td class="md" nowrap valign="top"> #define dk_len</td> |
| 127 |
<td class="md" valign="top">( </td> |
| 128 |
<td class="md" nowrap valign="top">key </td> |
| 129 |
<td class="mdname1" valign="top" nowrap> </td> |
| 130 |
<td class="md" valign="top">) </td> |
| 131 |
<td class="md" nowrap> |
| 132 |
</table> |
| 133 |
</td> |
| 134 |
</tr> |
| 135 |
</table> |
| 136 |
<table cellspacing=5 cellpadding=0 border=0> |
| 137 |
<tr> |
| 138 |
<td> |
| 139 |
|
| 140 |
</td> |
| 141 |
<td> |
| 142 |
|
| 143 |
<p> |
| 144 |
This macro allows access to the key length field of a <a class="el" href="group__dbprim.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.html#a0">db_key_t</a>.<dl compact><dt><b>Parameters: </b></dt><dd> |
| 145 |
<table border=0 cellspacing=2 cellpadding=0> |
| 146 |
<tr><td valign=top><em>key</em> </td><td> |
| 147 |
A pointer to a <a class="el" href="group__dbprim.html#a0">db_key_t</a>. </td></tr> |
| 148 |
</table> |
| 149 |
</dl><dl compact><dt><b>Returns: </b></dt><dd> |
| 150 |
An <code>int</code> describing the length of the key. </dl> </td> |
| 151 |
</tr> |
| 152 |
</table> |
| 153 |
<hr><h2>Typedef Documentation</h2> |
| 154 |
<a name="a0" doxytag="dbprim.h::db_key_t"></a><p> |
| 155 |
<table width="100%" cellpadding="2" cellspacing="0" border="0"> |
| 156 |
<tr> |
| 157 |
<td class="md"> |
| 158 |
<table cellpadding="0" cellspacing="0" border="0"> |
| 159 |
<tr> |
| 160 |
<td class="md" nowrap valign="top"> typedef struct _db_key_s db_key_t |
| 161 |
</table> |
| 162 |
</td> |
| 163 |
</tr> |
| 164 |
</table> |
| 165 |
<table cellspacing=5 cellpadding=0 border=0> |
| 166 |
<tr> |
| 167 |
<td> |
| 168 |
|
| 169 |
</td> |
| 170 |
<td> |
| 171 |
|
| 172 |
<p> |
| 173 |
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.html#a2">dk_key()</a> and <a class="el" href="group__dbprim.html#a3">dk_len()</a>. </td> |
| 174 |
</tr> |
| 175 |
</table> |
| 176 |
<hr><address style="align: right;"><small>Generated on Thu Dec 11 01:24:36 2003 for Database Primitives Library by |
| 177 |
<a href="http://www.doxygen.org/index.html"> |
| 178 |
<img src="doxygen.png" alt="doxygen" align="middle" border=0 |
| 179 |
width=110 height=53></a>1.2.18 </small></address> |
| 180 |
</body> |
| 181 |
</html> |
