← Back to branch summary

~ubuntu-branches/ubuntu/quantal/kyotocabinet/quantal

« back to all changes in this revision

Viewing changes to doc/api/classkyotocabinet_1_1TinyHashMap_1_1Iterator.html

  • Committer: Package Import Robot
  • Author(s): Shawn Landden
  • Date: 2012-06-07 16:12:07 UTC
  • Revision ID: package-import@ubuntu.com-20120607161207-prbj5blqgzzfl8of
Tags: upstream-1.2.76
Import upstream version 1.2.76

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/api/classkyotocabinet_1_1TinyHashMap_1_1Iterator.html
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 
2
<html xmlns="http://www.w3.org/1999/xhtml">
 
3
<head>
 
4
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
 
5
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
 
6
<title>Kyoto Cabinet: kyotocabinet::TinyHashMap::Iterator Class Reference</title>
 
7
 
 
8
<link href="tabs.css" rel="stylesheet" type="text/css"/>
 
9
<link href="doxygen.css" rel="stylesheet" type="text/css" />
 
10
 
 
11
 
 
12
 
 
13
</head>
 
14
<body>
 
15
<div id="top"><!-- do not remove this div! -->
 
16
 
 
17
 
 
18
<div id="titlearea">
 
19
<table cellspacing="0" cellpadding="0">
 
20
 <tbody>
 
21
 <tr style="height: 56px;">
 
22
  
 
23
  
 
24
  <td style="padding-left: 0.5em;">
 
25
   <div id="projectname">Kyoto Cabinet
 
26
   
 
27
   </div>
 
28
   
 
29
  </td>
 
30
  
 
31
  
 
32
  
 
33
 </tr>
 
34
 </tbody>
 
35
</table>
 
36
</div>
 
37
 
 
38
<!-- Generated by Doxygen 1.7.6.1 -->
 
39
  <div id="navrow1" class="tabs">
 
40
    <ul class="tablist">
 
41
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
 
42
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
 
43
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
 
44
      <li><a href="files.html"><span>Files</span></a></li>
 
45
    </ul>
 
46
  </div>
 
47
  <div id="navrow2" class="tabs2">
 
48
    <ul class="tablist">
 
49
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
 
50
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
 
51
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
 
52
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
 
53
    </ul>
 
54
  </div>
 
55
  <div id="nav-path" class="navpath">
 
56
    <ul>
 
57
      <li class="navelem"><a class="el" href="namespacekyotocabinet.html">kyotocabinet</a>      </li>
 
58
      <li class="navelem"><a class="el" href="classkyotocabinet_1_1TinyHashMap.html">TinyHashMap</a>      </li>
 
59
      <li class="navelem"><a class="el" href="classkyotocabinet_1_1TinyHashMap_1_1Iterator.html">Iterator</a>      </li>
 
60
    </ul>
 
61
  </div>
 
62
</div>
 
63
<div class="header">
 
64
  <div class="summary">
 
65
<a href="#pub-methods">Public Member Functions</a> &#124;
 
66
<a href="#friends">Friends</a>  </div>
 
67
  <div class="headertitle">
 
68
<div class="title">kyotocabinet::TinyHashMap::Iterator Class Reference</div>  </div>
 
69
</div><!--header-->
 
70
<div class="contents">
 
71
<!-- doxytag: class="kyotocabinet::TinyHashMap::Iterator" -->
 
72
<p><a class="el" href="classkyotocabinet_1_1TinyHashMap_1_1Iterator.html" title="Iterator of records.">Iterator</a> of records.  
 
73
 <a href="classkyotocabinet_1_1TinyHashMap_1_1Iterator.html#details">More...</a></p>
 
74
 
 
75
<p><code>#include &lt;kcmap.h&gt;</code></p>
 
76
 
 
77
<p><a href="classkyotocabinet_1_1TinyHashMap_1_1Iterator-members.html">List of all members.</a></p>
 
78
<table class="memberdecls">
 
79
<tr><td colspan="2"><h2><a name="pub-methods"></a>
 
80
Public Member Functions</h2></td></tr>
 
81
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1TinyHashMap_1_1Iterator.html#a43ebcee59269ef2094c530061a280f5d">Iterator</a> (<a class="el" href="classkyotocabinet_1_1TinyHashMap.html">TinyHashMap</a> *map)</td></tr>
 
82
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a43ebcee59269ef2094c530061a280f5d"></a><br/></td></tr>
 
83
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1TinyHashMap_1_1Iterator.html#a06fcdca617233a75ad9e1268ce48fa87">~Iterator</a> ()</td></tr>
 
84
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#a06fcdca617233a75ad9e1268ce48fa87"></a><br/></td></tr>
 
85
<tr><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1TinyHashMap_1_1Iterator.html#a46b1f3627cfd5fc7baa3c5d8e6dec47f">get_key</a> (size_t *sp)</td></tr>
 
86
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the key of the current record.  <a href="#a46b1f3627cfd5fc7baa3c5d8e6dec47f"></a><br/></td></tr>
 
87
<tr><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1TinyHashMap_1_1Iterator.html#a44d2e387ee466f4a40e5af033452110c">get_value</a> (size_t *sp)</td></tr>
 
88
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the value of the current record.  <a href="#a44d2e387ee466f4a40e5af033452110c"></a><br/></td></tr>
 
89
<tr><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1TinyHashMap_1_1Iterator.html#a380323d0d6ef7b6768b11fcf10407790">get</a> (size_t *ksp, const char **vbp, size_t *vsp)</td></tr>
 
90
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a pair of the key and the value of the current record.  <a href="#a380323d0d6ef7b6768b11fcf10407790"></a><br/></td></tr>
 
91
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1TinyHashMap_1_1Iterator.html#abbc96f3a51b8dfbd596a9b69b69f4b53">step</a> ()</td></tr>
 
92
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Step the cursor to the next record.  <a href="#abbc96f3a51b8dfbd596a9b69b69f4b53"></a><br/></td></tr>
 
93
<tr><td colspan="2"><h2><a name="friends"></a>
 
94
Friends</h2></td></tr>
 
95
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afa0031e3ce6b9954988a99feb8ba24ea"></a><!-- doxytag: member="kyotocabinet::TinyHashMap::Iterator::TinyHashMap" ref="afa0031e3ce6b9954988a99feb8ba24ea" args="" -->
 
96
class&#160;</td><td class="memItemRight" valign="bottom"><b>TinyHashMap</b></td></tr>
 
97
</table>
 
98
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
 
99
<div class="textblock"><p><a class="el" href="classkyotocabinet_1_1TinyHashMap_1_1Iterator.html" title="Iterator of records.">Iterator</a> of records. </p>
 
100
</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
 
101
<a class="anchor" id="a43ebcee59269ef2094c530061a280f5d"></a><!-- doxytag: member="kyotocabinet::TinyHashMap::Iterator::Iterator" ref="a43ebcee59269ef2094c530061a280f5d" args="(TinyHashMap *map)" -->
 
102
<div class="memitem">
 
103
<div class="memproto">
 
104
      <table class="memname">
 
105
        <tr>
 
106
          <td class="memname"><a class="el" href="classkyotocabinet_1_1TinyHashMap_1_1Iterator.html#a43ebcee59269ef2094c530061a280f5d">kyotocabinet::TinyHashMap::Iterator::Iterator</a> </td>
 
107
          <td>(</td>
 
108
          <td class="paramtype"><a class="el" href="classkyotocabinet_1_1TinyHashMap.html">TinyHashMap</a> *&#160;</td>
 
109
          <td class="paramname"><em>map</em></td><td>)</td>
 
110
          <td><code> [explicit]</code></td>
 
111
        </tr>
 
112
      </table>
 
113
</div>
 
114
<div class="memdoc">
 
115
 
 
116
<p>Constructor. </p>
 
117
<dl class="params"><dt><b>Parameters:</b></dt><dd>
 
118
  <table class="params">
 
119
    <tr><td class="paramname">map</td><td>the container. </td></tr>
 
120
  </table>
 
121
  </dd>
 
122
</dl>
 
123
<dl class="note"><dt><b>Note:</b></dt><dd>This object will not be invalidated even when the map object is updated once. However, phantom records may be retrieved if they are removed after creation of each iterator. </dd></dl>
 
124
 
 
125
</div>
 
126
</div>
 
127
<a class="anchor" id="a06fcdca617233a75ad9e1268ce48fa87"></a><!-- doxytag: member="kyotocabinet::TinyHashMap::Iterator::~Iterator" ref="a06fcdca617233a75ad9e1268ce48fa87" args="()" -->
 
128
<div class="memitem">
 
129
<div class="memproto">
 
130
      <table class="memname">
 
131
        <tr>
 
132
          <td class="memname"><a class="el" href="classkyotocabinet_1_1TinyHashMap_1_1Iterator.html#a06fcdca617233a75ad9e1268ce48fa87">kyotocabinet::TinyHashMap::Iterator::~Iterator</a> </td>
 
133
          <td>(</td>
 
134
          <td class="paramname"></td><td>)</td>
 
135
          <td></td>
 
136
        </tr>
 
137
      </table>
 
138
</div>
 
139
<div class="memdoc">
 
140
 
 
141
<p>Destructor. </p>
 
142
 
 
143
</div>
 
144
</div>
 
145
<hr/><h2>Member Function Documentation</h2>
 
146
<a class="anchor" id="a46b1f3627cfd5fc7baa3c5d8e6dec47f"></a><!-- doxytag: member="kyotocabinet::TinyHashMap::Iterator::get_key" ref="a46b1f3627cfd5fc7baa3c5d8e6dec47f" args="(size_t *sp)" -->
 
147
<div class="memitem">
 
148
<div class="memproto">
 
149
      <table class="memname">
 
150
        <tr>
 
151
          <td class="memname">const char* <a class="el" href="classkyotocabinet_1_1TinyHashMap_1_1Iterator.html#a46b1f3627cfd5fc7baa3c5d8e6dec47f">kyotocabinet::TinyHashMap::Iterator::get_key</a> </td>
 
152
          <td>(</td>
 
153
          <td class="paramtype">size_t *&#160;</td>
 
154
          <td class="paramname"><em>sp</em></td><td>)</td>
 
155
          <td></td>
 
156
        </tr>
 
157
      </table>
 
158
</div>
 
159
<div class="memdoc">
 
160
 
 
161
<p>Get the key of the current record. </p>
 
162
<dl class="params"><dt><b>Parameters:</b></dt><dd>
 
163
  <table class="params">
 
164
    <tr><td class="paramname">sp</td><td>the pointer to the variable into which the size of the region of the return value is assigned. </td></tr>
 
165
  </table>
 
166
  </dd>
 
167
</dl>
 
168
<dl class="return"><dt><b>Returns:</b></dt><dd>the pointer to the key region of the current record, or NULL on failure. </dd></dl>
 
169
 
 
170
</div>
 
171
</div>
 
172
<a class="anchor" id="a44d2e387ee466f4a40e5af033452110c"></a><!-- doxytag: member="kyotocabinet::TinyHashMap::Iterator::get_value" ref="a44d2e387ee466f4a40e5af033452110c" args="(size_t *sp)" -->
 
173
<div class="memitem">
 
174
<div class="memproto">
 
175
      <table class="memname">
 
176
        <tr>
 
177
          <td class="memname">const char* <a class="el" href="classkyotocabinet_1_1TinyHashMap_1_1Iterator.html#a44d2e387ee466f4a40e5af033452110c">kyotocabinet::TinyHashMap::Iterator::get_value</a> </td>
 
178
          <td>(</td>
 
179
          <td class="paramtype">size_t *&#160;</td>
 
180
          <td class="paramname"><em>sp</em></td><td>)</td>
 
181
          <td></td>
 
182
        </tr>
 
183
      </table>
 
184
</div>
 
185
<div class="memdoc">
 
186
 
 
187
<p>Get the value of the current record. </p>
 
188
<dl class="params"><dt><b>Parameters:</b></dt><dd>
 
189
  <table class="params">
 
190
    <tr><td class="paramname">sp</td><td>the pointer to the variable into which the size of the region of the return value is assigned. </td></tr>
 
191
  </table>
 
192
  </dd>
 
193
</dl>
 
194
<dl class="return"><dt><b>Returns:</b></dt><dd>the pointer to the value region of the current record, or NULL on failure. </dd></dl>
 
195
 
 
196
</div>
 
197
</div>
 
198
<a class="anchor" id="a380323d0d6ef7b6768b11fcf10407790"></a><!-- doxytag: member="kyotocabinet::TinyHashMap::Iterator::get" ref="a380323d0d6ef7b6768b11fcf10407790" args="(size_t *ksp, const char **vbp, size_t *vsp)" -->
 
199
<div class="memitem">
 
200
<div class="memproto">
 
201
      <table class="memname">
 
202
        <tr>
 
203
          <td class="memname">const char* <a class="el" href="classkyotocabinet_1_1TinyHashMap_1_1Iterator.html#a380323d0d6ef7b6768b11fcf10407790">kyotocabinet::TinyHashMap::Iterator::get</a> </td>
 
204
          <td>(</td>
 
205
          <td class="paramtype">size_t *&#160;</td>
 
206
          <td class="paramname"><em>ksp</em>, </td>
 
207
        </tr>
 
208
        <tr>
 
209
          <td class="paramkey"></td>
 
210
          <td></td>
 
211
          <td class="paramtype">const char **&#160;</td>
 
212
          <td class="paramname"><em>vbp</em>, </td>
 
213
        </tr>
 
214
        <tr>
 
215
          <td class="paramkey"></td>
 
216
          <td></td>
 
217
          <td class="paramtype">size_t *&#160;</td>
 
218
          <td class="paramname"><em>vsp</em>&#160;</td>
 
219
        </tr>
 
220
        <tr>
 
221
          <td></td>
 
222
          <td>)</td>
 
223
          <td></td><td></td>
 
224
        </tr>
 
225
      </table>
 
226
</div>
 
227
<div class="memdoc">
 
228
 
 
229
<p>Get a pair of the key and the value of the current record. </p>
 
230
<dl class="params"><dt><b>Parameters:</b></dt><dd>
 
231
  <table class="params">
 
232
    <tr><td class="paramname">ksp</td><td>the pointer to the variable into which the size of the region of the return value is assigned. </td></tr>
 
233
    <tr><td class="paramname">vbp</td><td>the pointer to the variable into which the pointer to the value region is assigned. </td></tr>
 
234
    <tr><td class="paramname">vsp</td><td>the pointer to the variable into which the size of the value region is assigned. </td></tr>
 
235
  </table>
 
236
  </dd>
 
237
</dl>
 
238
<dl class="return"><dt><b>Returns:</b></dt><dd>the pointer to the key region, or NULL on failure. </dd></dl>
 
239
 
 
240
</div>
 
241
</div>
 
242
<a class="anchor" id="abbc96f3a51b8dfbd596a9b69b69f4b53"></a><!-- doxytag: member="kyotocabinet::TinyHashMap::Iterator::step" ref="abbc96f3a51b8dfbd596a9b69b69f4b53" args="()" -->
 
243
<div class="memitem">
 
244
<div class="memproto">
 
245
      <table class="memname">
 
246
        <tr>
 
247
          <td class="memname">void <a class="el" href="classkyotocabinet_1_1TinyHashMap_1_1Iterator.html#abbc96f3a51b8dfbd596a9b69b69f4b53">kyotocabinet::TinyHashMap::Iterator::step</a> </td>
 
248
          <td>(</td>
 
249
          <td class="paramname"></td><td>)</td>
 
250
          <td></td>
 
251
        </tr>
 
252
      </table>
 
253
</div>
 
254
<div class="memdoc">
 
255
 
 
256
<p>Step the cursor to the next record. </p>
 
257
 
 
258
</div>
 
259
</div>
 
260
</div><!-- contents -->
 
261
 
 
262
 
 
263
<hr class="footer"/><address class="footer"><small>
 
264
Generated on Fri May 25 2012 01:21:36 for Kyoto Cabinet by &#160;<a href="http://www.doxygen.org/index.html">
 
265
<img class="footer" src="doxygen.png" alt="doxygen"/>
 
266
</a> 1.7.6.1
 
267
</small></address>
 
268
 
 
269
</body>
 
270
</html>