Sindbad~EG File Manager
<?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="dbslice_lookup.html" title="Db::slice_lookup()" />
<link rel="next" href="dbstat.html" title="Db::stat()" />
</head>
<body>
<div xmlns="" class="navheader">
<div class="libver">
<p>Library Version 18.1.40</p>
</div>
<table width="100%" summary="Navigation header">
<tr>
<th colspan="3" align="center">
<span xmlns="http://www.w3.org/1999/xhtml">Db::sort_multiple()</span>
</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="dbslice_lookup.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>
<span>Db::sort_multiple()</span>
</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="idm139755617822192"></a>Parameters</h3>
</div>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idm139755617894880"></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="idm139755617840592"></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="idm139755617804304"></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="idm139755617747200"></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="idm139755617704496"></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="idm139755617706992"></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="idm139755617713744"></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="idm139755617744064"></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="dbslice_lookup.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">
<span>Db::slice_lookup()</span>
</td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top">
<span>Db::stat()</span>
</td>
</tr>
</table>
</div>
</body>
</html>
Sindbad File Manager Version 1.0, Coded By Sindbad EG ~ The Terrorists