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
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
|
<?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>Db::sort_multiple()</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="db.html" title="Chapter 2. The Db Handle" />
<link rel="prev" href="dbset_re_source.html" title="Db::set_re_source()" />
<link rel="next" href="dbstat.html" title="Db::stat()" />
</head>
<body>
<div xmlns="" class="navheader">
<div class="libver">
<p>Library Version 11.2.5.3</p>
</div>
<table width="100%" summary="Navigation header">
<tr>
<th colspan="3" align="center">Db::sort_multiple()</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="dbset_re_source.html">Prev</a> </td>
<th width="60%" align="center">Chapter 2.
The Db Handle
</th>
<td width="20%" align="right"> <a accesskey="n" href="dbstat.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="dbsort_multiple"></a>Db::sort_multiple()</h2>
</div>
</div>
</div>
<pre class="programlisting">#include <db_cxx.h>
int
Db::sort_multiple(Dbt *key, Dbt *data, u_int32_t flags);</pre>
<p>
The <code class="methodname">Db::sort_multiple()</code> method is used
to sort a set of <a class="link" href="dbt.html" title="Chapter 4. The Dbt Handle">Dbt</a>s into
database insert order.
</p>
<p>
If specified the application specific btree comparison and
duplicate comparison functions will be used if they are
configured.
</p>
<p>
The key and data parameters must contain pairs of items. That is
the n-th entry in <span class="bold"><strong>key</strong></span> must
correspond to the n-th entry in
<span class="bold"><strong>data</strong></span>.
</p>
<p>
The <code class="methodname">Db::sort_multiple()</code> <span>
<span>
method either returns a non-zero error value or throws an
exception that encapsulates a non-zero error value on
failure, and returns 0 on success.
</span>
</span>
</p>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp5869984"></a>Parameters</h3>
</div>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp5870584"></a>key</h4>
</div>
</div>
</div>
<p>
The <span class="bold"><strong>key</strong></span> parameter must
contain a set of <a class="link" href="dbt.html" title="Chapter 4. The Dbt Handle">Dbt</a>
entries in
<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>
format.
</p>
<p>
The sorted entries will be returned in the
<span class="bold"><strong>key</strong></span> parameter.
</p>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp5849984"></a>data</h4>
</div>
</div>
</div>
<p>
If non-NULL, the <span class="bold"><strong>data</strong></span>
parameter must contain a set of
<a class="link" href="dbt.html" title="Chapter 4. The Dbt Handle">Dbt</a>s entries in
<a class="link" href="dbcget.html#dbcget_DB_MULTIPLE">DB_MULTIPLE</a>
format. Each entry must correspond to an entry in the
<span class="bold"><strong>key</strong></span> parameter.
</p>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp5869656"></a>flags</h4>
</div>
</div>
</div>
<p>
The <span class="bold"><strong>flags</strong></span> parameter must
be set to one of the following values:
</p>
<div class="itemizedlist">
<ul type="disc">
<li>
<p><a id="sort_multiple_DB_MULTIPLE"></a>
DB_MULTIPLE
</p>
<p>
Sorts one or two
<a class="link" href="dbcget.html#dbcget_DB_MULTIPLE">DB_MULTIPLE</a>
format <a class="link" href="dbt.html" title="Chapter 4. The Dbt Handle">Dbt</a>s.
Assumes that <span class="bold"><strong>key</strong></span>
and <span class="bold"><strong>data</strong></span> specify
pairs of key and data items to sort together. If
the <span class="bold"><strong>data</strong></span> parameter
is NULL the API will sort the key arrays according
to the btree comparison function.
</p>
</li>
<li>
<p><a id="sort_multiple_DB_MULTIPLE_KEY"></a>
DB_MULTIPLE_KEY
</p>
<p>
Sorts a
<a class="link" href="dbcget.html#dbcget_DB_MULTIPLE_KEY">DB_MULTIPLE_KEY</a>
format <a class="link" href="dbt.html" title="Chapter 4. The Dbt Handle">Dbt</a>.
</p>
</li>
</ul>
</div>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp5876784"></a>Errors</h3>
</div>
</div>
</div>
<p>
The <code class="methodname">Db::sort_multiple()</code> <span>
<span>
method may fail and throw a <a class="link" href="dbexception.html" title="Chapter 6. The DbException Class">DbException</a>
exception, encapsulating one of the following non-zero errors, or return one
of the following non-zero errors:
</span>
</span>
</p>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp5889992"></a>EACCES</h4>
</div>
</div>
</div>
<p>
An attempt was made to modify a read-only database.
</p>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp5888696"></a>EINVAL</h4>
</div>
</div>
</div>
<p>
An invalid flag value or parameter was specified.
</p>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp5887400"></a>Class</h3>
</div>
</div>
</div>
<p>
<a class="link" href="db.html" title="Chapter 2. The Db Handle">Db</a>
</p>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp5883784"></a>See Also</h3>
</div>
</div>
</div>
<p>
<a class="xref" href="db.html#dblist" title="Database and Related Methods">Database and Related Methods</a>
</p>
<p>
</p>
<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="dbset_re_source.html">Prev</a> </td>
<td width="20%" align="center">
<a accesskey="u" href="db.html">Up</a>
</td>
<td width="40%" align="right"> <a accesskey="n" href="dbstat.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">Db::set_re_source() </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> Db::stat()</td>
</tr>
</table>
</div>
</body>
</html>
|
