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
|
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!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/html; charset=UTF-8" />
<title>DbMultipleKeyDataIterator</title>
<link rel="stylesheet" href="apiReference.css" type="text/css" />
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2" />
<link rel="start" href="index.html" title="Berkeley DB C++ API Reference" />
<link rel="up" href="dbt.html" title="Chapter 4. The Dbt Handle" />
<link rel="prev" href="dbmultipledataiterator.html" title="DbMultipleDataIterator" />
<link rel="next" href="dbmultiplerecnodataiterator.html" title="DbMultipleRecnoDataIterator" />
</head>
<body>
<div class="navheader">
<table width="100%" summary="Navigation header">
<tr>
<th colspan="3" align="center">DbMultipleKeyDataIterator</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="dbmultipledataiterator.html">Prev</a> </td>
<th width="60%" align="center">Chapter 4.
The Dbt Handle
</th>
<td width="20%" align="right"> <a accesskey="n" href="dbmultiplerecnodataiterator.html">Next</a></td>
</tr>
</table>
<hr />
</div>
<div class="sect1" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both"><a id="dbmultiplekeydataiterator"></a>DbMultipleKeyDataIterator</h2>
</div>
</div>
</div>
<pre class="programlisting">#include <db_cxx.h>
class DbMultipleKeyDataIterator
{
public:
DbMultipleKeyDataIterator(const Dbt &dbt);
bool next(Dbt &key, Dbt &data);
}; </pre>
<p>
If either of the
<a class="link" href="dbcget.html#dbcget_DB_MULTIPLE">DB_MULTIPLE</a>
or
<a class="link" href="dbcget.html#dbcget_DB_MULTIPLE_KEY">DB_MULTIPLE_KEY</a>
flags were specified to the <a class="xref" href="dbget.html" title="Db::get()">Db::get()</a> or
<a class="xref" href="dbcget.html" title="Dbc::get()">Dbc::get()</a> methods, the data
<a class="link" href="dbt.html" title="Chapter 4. The Dbt Handle">Dbt</a> returned by those interfaces will
refer to a buffer that is filled with data. Access to that data is through these
classes.
</p>
<p>
The <code class="classname">DbMultipleDataIterator</code> class is used to iterate through data
returned using the
<a class="link" href="dbcget.html#dbcget_DB_MULTIPLE_KEY">DB_MULTIPLE_KEY</a>
flag from a database belonging to Btree or Hash access methods.
</p>
<p>
The constructor takes the <a class="xref" href="dbt.html" title="Chapter 4. The Dbt Handle">
The Dbt Handle
</a>
returned by the call to <a class="xref" href="dbget.html" title="Db::get()">Db::get()</a>
or <a class="xref" href="dbcget.html" title="Dbc::get()">Dbc::get()</a> that used the
<a class="link" href="dbcget.html#dbcget_DB_MULTIPLE_KEY">DB_MULTIPLE_KEY</a>
flag.
</p>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
<p>
All instances of the bulk retrieval classes may be used only
once, and to traverse the bulk retrieval buffer in the forward
direction only. However, they are nondestructive, so multiple
iterators can be instantiated and used on the same returned
data <a class="link" href="dbt.html" title="Chapter 4. The Dbt Handle">Dbt</a>.
</p>
</div>
<p>
Parameters are:
</p>
<div class="itemizedlist">
<ul type="disc">
<li>
<p>
<code class="literal">dbt</code>
</p>
<p>
The <span class="bold"><strong>dbt</strong></span> parameter is a
data <a class="xref" href="dbt.html" title="Chapter 4. The Dbt Handle">
The Dbt Handle
</a>
returned by the call to <a class="xref" href="dbget.html" title="Db::get()">Db::get()</a>
or <a class="xref" href="dbcget.html" title="Dbc::get()">Dbc::get()</a> that used the
<a class="link" href="dbcget.html#dbcget_DB_MULTIPLE_KEY">DB_MULTIPLE_KEY</a>
flag.
</p>
</li>
</ul>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="dbmultiplekeydataiterator.next"></a>DbMultipleKeyDataIterator.next()</h3>
</div>
</div>
</div>
<p>
The <code class="methodname">DbMultipleKeyDataIterator.next()</code> method
returns the next data item in the original bulk retrieval buffer.
</p>
<p>
The <code class="methodname">DbMultipleKeyDataIterator.next()</code> method
method returns <code class="literal">false</code> if no more data are available, and
<code class="literal">true</code> otherwise.
</p>
<p>
Parameters are:
</p>
<div class="itemizedlist">
<ul type="disc">
<li>
<p>
<code class="literal">key</code>
</p>
<p>
The <span class="bold"><strong>key</strong></span> parameter is a
<a class="xref" href="dbt.html" title="Chapter 4. The Dbt Handle">
The Dbt Handle
</a>
that will be filled in with a reference to a buffer, a
size, and an offset that together yield the next data item
in the original bulk retrieval buffer.
</p>
</li>
<li>
<p>
<code class="literal">data</code>
</p>
<p>
The <span class="bold"><strong>data</strong></span> parameter is a
<a class="xref" href="dbt.html" title="Chapter 4. The Dbt Handle">
The Dbt Handle
</a>
that will be filled in with a reference to a buffer, a
size, and an offset that together yield the next data item
in the original bulk retrieval buffer.
</p>
</li>
</ul>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp51397144"></a>Class</h3>
</div>
</div>
</div>
<p>
<a class="link" href="dbmultipleiterator.html" title="DbMultipleIterator">DbMultipleIterator</a>
</p>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp51392400"></a>See Also</h3>
</div>
</div>
</div>
<p>
<a class="xref" href="dbt.html#dbtlist" title="DBT and Bulk Operations">DBT and Bulk Operations</a>
</p>
</div>
</div>
<div class="navfooter">
<hr />
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left"><a accesskey="p" href="dbmultipledataiterator.html">Prev</a> </td>
<td width="20%" align="center">
<a accesskey="u" href="dbt.html">Up</a>
</td>
<td width="40%" align="right"> <a accesskey="n" href="dbmultiplerecnodataiterator.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">DbMultipleDataIterator </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> DbMultipleRecnoDataIterator</td>
</tr>
</table>
</div>
</body>
</html>
|
