/usr/share/doc/libvdkxdb2-dev/classVDKXTableIndex.html is in libvdkxdb2-dev 2.4.0-3.4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 | <!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>vdkxdb 2.4.0: VDKXTableIndex Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">vdkxdb 2.4.0
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.2 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classVDKXTableIndex-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">VDKXTableIndex Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Provides a table index.
<a href="classVDKXTableIndex.html#details">More...</a></p>
<p><code>#include <<a class="el" href="vdkxtable_8h_source.html">vdkxtable.h</a>></code></p>
<p>Inherits xbNdx.</p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:abd890649336b25b1b07d24afde7ca6f0"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classVDKXTableIndex.html#abd890649336b25b1b07d24afde7ca6f0">VDKXTableIndex</a> (<a class="el" href="classVDKXTable.html">VDKXTable</a> *owner, char *s)</td></tr>
<tr class="separator:abd890649336b25b1b07d24afde7ca6f0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acd4788999086aa15665fbb92d6813ab9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acd4788999086aa15665fbb92d6813ab9"></a>
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classVDKXTableIndex.html#acd4788999086aa15665fbb92d6813ab9">~VDKXTableIndex</a> ()</td></tr>
<tr class="memdesc:acd4788999086aa15665fbb92d6813ab9"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br/></td></tr>
<tr class="separator:acd4788999086aa15665fbb92d6813ab9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2afa5e099fa22318c3118b6002146de8"><td class="memItemLeft" align="right" valign="top">xbShort </td><td class="memItemRight" valign="bottom"><a class="el" href="classVDKXTableIndex.html#a2afa5e099fa22318c3118b6002146de8">Create</a> (char *key, bool unique=true, bool overwrite=false)</td></tr>
<tr class="separator:a2afa5e099fa22318c3118b6002146de8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a65cd6f882f17f39676adb63064cd2f4b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a65cd6f882f17f39676adb63064cd2f4b"></a>
xbShort </td><td class="memItemRight" valign="bottom"><a class="el" href="classVDKXTableIndex.html#a65cd6f882f17f39676adb63064cd2f4b">Open</a> (void)</td></tr>
<tr class="memdesc:a65cd6f882f17f39676adb63064cd2f4b"><td class="mdescLeft"> </td><td class="mdescRight">Open index. <br/></td></tr>
<tr class="separator:a65cd6f882f17f39676adb63064cd2f4b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ade861a240bdfb452c6dc59b857b52dc7"><td class="memItemLeft" align="right" valign="top">xbShort </td><td class="memItemRight" valign="bottom"><a class="el" href="classVDKXTableIndex.html#ade861a240bdfb452c6dc59b857b52dc7">Close</a> (void)</td></tr>
<tr class="separator:ade861a240bdfb452c6dc59b857b52dc7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a06270c8dcfe7134e6b1e1d9b2b258b60"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a06270c8dcfe7134e6b1e1d9b2b258b60"></a>
VDKString </td><td class="memItemRight" valign="bottom"><a class="el" href="classVDKXTableIndex.html#a06270c8dcfe7134e6b1e1d9b2b258b60">Name</a> ()</td></tr>
<tr class="memdesc:a06270c8dcfe7134e6b1e1d9b2b258b60"><td class="mdescLeft"> </td><td class="mdescRight">return index name <br/></td></tr>
<tr class="separator:a06270c8dcfe7134e6b1e1d9b2b258b60"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac588947dcd0ce0fb5703460d6850b6e9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac588947dcd0ce0fb5703460d6850b6e9"></a>
VDKString </td><td class="memItemRight" valign="bottom"><a class="el" href="classVDKXTableIndex.html#ac588947dcd0ce0fb5703460d6850b6e9">Key</a> ()</td></tr>
<tr class="memdesc:ac588947dcd0ce0fb5703460d6850b6e9"><td class="mdescLeft"> </td><td class="mdescRight">return index key <br/></td></tr>
<tr class="separator:ac588947dcd0ce0fb5703460d6850b6e9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afdcb3def2e5dd6078e369cb5e39b9d48"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afdcb3def2e5dd6078e369cb5e39b9d48"></a>
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classVDKXTableIndex.html#afdcb3def2e5dd6078e369cb5e39b9d48">IsOpen</a> ()</td></tr>
<tr class="memdesc:afdcb3def2e5dd6078e369cb5e39b9d48"><td class="mdescLeft"> </td><td class="mdescRight">return if index is open or not <br/></td></tr>
<tr class="separator:afdcb3def2e5dd6078e369cb5e39b9d48"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Provides a table index. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="abd890649336b25b1b07d24afde7ca6f0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">VDKXTableIndex::VDKXTableIndex </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classVDKXTable.html">VDKXTable</a> * </td>
<td class="paramname"><em>owner</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"><em>s</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">owner</td><td>VDKXtable that owns index </td></tr>
<tr><td class="paramname">s</td><td>index file name </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ade861a240bdfb452c6dc59b857b52dc7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">xbShort VDKXTableIndex::Close </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Close index. </p>
<ul>
<li>Programming note: Isn't necessary to explicitely close an index, closing the table will close all associated indexes as well. </li>
</ul>
</div>
</div>
<a class="anchor" id="a2afa5e099fa22318c3118b6002146de8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">xbShort VDKXTableIndex::Create </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>unique</em> = <code>true</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>overwrite</em> = <code>false</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates an index </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">k</td><td>index key (can be an expression as well) </td></tr>
<tr><td class="paramname">unique</td><td>if true allows duplicated keys </td></tr>
<tr><td class="paramname">overwrite</td><td>if true and table exist will be truncated and overwritten. Returns: <ul>
<li>XB_NO_ERROR no errors </li>
<li>XB_OPEN_ERROR couldn't open file </li>
<li>XB_NO_MEMORY mem allocation error </li>
<li>XB_READ_ERROR couldn't read on device </li>
<li>XB_INVALID_KEY_EXPRESSION bad index key expression </li>
<li>XB_SEEK_ERROR seek error encountered </li>
<li>XB_NOT_OPEN database wasn't opened </li>
</ul>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="vdkxtable_8h_source.html">vdkxtable.h</a></li>
<li>vdkxtable.cc</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Dec 3 2012 11:07:37 for vdkxdb 2.4.0 by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.2
</small></address>
</body>
</html>
|