summaryrefslogtreecommitdiff
path: root/docs/api_reference/C/dbset_bt_compare.html
diff options
context:
space:
mode:
authorLorry Tar Creator <lorry-tar-importer@baserock.org>2015-02-17 17:25:57 +0000
committer <>2015-03-17 16:26:24 +0000
commit780b92ada9afcf1d58085a83a0b9e6bc982203d1 (patch)
tree598f8b9fa431b228d29897e798de4ac0c1d3d970 /docs/api_reference/C/dbset_bt_compare.html
parent7a2660ba9cc2dc03a69ddfcfd95369395cc87444 (diff)
downloadberkeleydb-master.tar.gz
Imported from /home/lorry/working-area/delta_berkeleydb/db-6.1.23.tar.gz.HEADdb-6.1.23master
Diffstat (limited to 'docs/api_reference/C/dbset_bt_compare.html')
-rw-r--r--docs/api_reference/C/dbset_bt_compare.html29
1 files changed, 19 insertions, 10 deletions
diff --git a/docs/api_reference/C/dbset_bt_compare.html b/docs/api_reference/C/dbset_bt_compare.html
index 53436f2d..1b406c24 100644
--- a/docs/api_reference/C/dbset_bt_compare.html
+++ b/docs/api_reference/C/dbset_bt_compare.html
@@ -14,7 +14,7 @@
<body>
<div xmlns="" class="navheader">
<div class="libver">
- <p>Library Version 11.2.5.3</p>
+ <p>Library Version 12.1.6.1</p>
</div>
<table width="100%" summary="Navigation header">
<tr>
@@ -41,8 +41,8 @@
<pre class="programlisting">#include &lt;db.h&gt;
int
-DB-&gt;set_bt_compare(DB *db,
- int (*bt_compare_fcn)(DB *db, const DBT *dbt1, const DBT *dbt2)); </pre>
+DB-&gt;set_bt_compare(DB *db, int (*bt_compare_fcn)(DB *db,
+ const DBT *dbt1, const DBT *dbt2, size_t *locp)); </pre>
<p>
Set the Btree key comparison function. The comparison function is
called whenever it is necessary to compare a key specified by the
@@ -76,7 +76,7 @@ DB-&gt;set_bt_compare(DB *db,
<div class="titlepage">
<div>
<div>
- <h3 class="title"><a id="idp58023488"></a>Parameters</h3>
+ <h3 class="title"><a id="idm7888584"></a>Parameters</h3>
</div>
</div>
</div>
@@ -84,14 +84,14 @@ DB-&gt;set_bt_compare(DB *db,
<div class="titlepage">
<div>
<div>
- <h4 class="title"><a id="idp58064680"></a>bt_compare_fcn</h4>
+ <h4 class="title"><a id="idm4000632"></a>bt_compare_fcn</h4>
</div>
</div>
</div>
<p>
The <span class="bold"><strong>bt_compare_fcn</strong></span> function is the
application-specified Btree comparison function. The comparison
- function takes three parameters:
+ function takes four parameters:
</p>
<div class="itemizedlist">
<ul type="disc">
@@ -124,6 +124,15 @@ DB-&gt;set_bt_compare(DB *db,
tree's key.
</p>
</li>
+ <li>
+ <p>
+ <code class="literal">locp</code>
+ </p>
+ <p>
+ The <span class="bold"><strong>locp</strong></span> parameter is currently
+ unused, and must be set to NULL or corruption can occur.
+ </p>
+ </li>
</ul>
</div>
<p>
@@ -149,7 +158,7 @@ DB-&gt;set_bt_compare(DB *db,
<div class="titlepage">
<div>
<div>
- <h3 class="title"><a id="idp58043144"></a>Errors</h3>
+ <h3 class="title"><a id="idm2282848"></a>Errors</h3>
</div>
</div>
</div>
@@ -165,7 +174,7 @@ DB-&gt;set_bt_compare(DB *db,
<div class="titlepage">
<div>
<div>
- <h4 class="title"><a id="idp58084576"></a>EINVAL</h4>
+ <h4 class="title"><a id="idm1666048"></a>EINVAL</h4>
</div>
</div>
</div>
@@ -179,7 +188,7 @@ DB-&gt;set_bt_compare(DB *db,
<div class="titlepage">
<div>
<div>
- <h3 class="title"><a id="idp58085656"></a>Class</h3>
+ <h3 class="title"><a id="idm2168672"></a>Class</h3>
</div>
</div>
</div>
@@ -191,7 +200,7 @@ DB-&gt;set_bt_compare(DB *db,
<div class="titlepage">
<div>
<div>
- <h3 class="title"><a id="idp58081424"></a>See Also</h3>
+ <h3 class="title"><a id="idm4439112"></a>See Also</h3>
</div>
</div>
</div>