diff options
Diffstat (limited to 'bdb/docs/api_c/db_set_bt_compare.html')
| -rw-r--r-- | bdb/docs/api_c/db_set_bt_compare.html | 105 |
1 files changed, 0 insertions, 105 deletions
diff --git a/bdb/docs/api_c/db_set_bt_compare.html b/bdb/docs/api_c/db_set_bt_compare.html deleted file mode 100644 index bf38ee51d94..00000000000 --- a/bdb/docs/api_c/db_set_bt_compare.html +++ /dev/null @@ -1,105 +0,0 @@ -<!--$Id: db_set_bt_compare.so,v 10.24 2000/10/26 15:20:40 bostic Exp $--> -<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> -<!--All rights reserved.--> -<html> -<head> -<title>Berkeley DB: DB->set_bt_compare</title> -<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> -<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> -</head> -<body bgcolor=white> - <a name="2"><!--meow--></a> -<table><tr valign=top> -<td> -<h1>DB->set_bt_compare</h1> -</td> -<td width="1%"> -<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> -</td></tr></table> -<hr size=1 noshade> -<tt> -<h3><pre> -#include <db.h> -<p> -int -DB->set_bt_compare(DB *db, - int (*bt_compare_fcn)(DB *, const DBT *, const DBT *)); -</pre></h3> -<h1>Description</h1> -<p>Set the Btree key comparison function. The comparison function is -called when it is necessary to compare a key specified by the -application with a key currently stored in the tree. The first argument -to the comparison function is the <a href="../api_c/dbt.html">DBT</a> representing the -application supplied key, the second is the current tree's key. -<p>The comparison function must return an integer value less than, equal -to, or greater than zero if the first key argument is considered to be -respectively less than, equal to, or greater than the second key -argument. In addition, the comparison function must cause the keys in -the database to be <i>well-ordered</i>. The comparison function -must correctly handle any key values used by the application (possibly -including zero-length keys). In addition, when Btree key prefix -comparison is being performed (see <a href="../api_c/db_set_bt_prefix.html">DB->set_bt_prefix</a> for more -information), the comparison routine may be passed a prefix of any -database key. The <b>data</b> and <b>size</b> fields of the -<a href="../api_c/dbt.html">DBT</a> are the only fields that may be used for the purposes of -this comparison. -<p>If no comparison function is specified, the keys are compared lexically, -with shorter keys collating before longer keys. The same comparison -method must be used each time a particular Btree is opened. -<p>The DB->set_bt_compare interface may only be used to configure Berkeley DB before -the <a href="../api_c/db_open.html">DB->open</a> interface is called. -<p>The DB->set_bt_compare function returns a non-zero error value on failure and 0 on success. -<h1>Errors</h1> -<p><dl compact> -<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. -<p>Called after <a href="../api_c/db_open.html">DB->open</a> was called. -</dl> -<h1>See Also</h1> -<a href="../api_c/db_create.html">db_create</a>, -<a href="../api_c/db_close.html">DB->close</a>, -<a href="../api_c/db_cursor.html">DB->cursor</a>, -<a href="../api_c/db_del.html">DB->del</a>, -<a href="../api_c/db_err.html">DB->err</a>, -<a href="../api_c/db_fd.html">DB->fd</a>, -<a href="../api_c/db_get.html">DB->get</a>, -<a href="../api_c/db_get_byteswapped.html">DB->get_byteswapped</a>, -<a href="../api_c/db_get_type.html">DB->get_type</a>, -<a href="../api_c/db_join.html">DB->join</a>, -<a href="../api_c/db_key_range.html">DB->key_range</a>, -<a href="../api_c/db_open.html">DB->open</a>, -<a href="../api_c/db_put.html">DB->put</a>, -<a href="../api_c/db_remove.html">DB->remove</a>, -<a href="../api_c/db_set_bt_compare.html">DB->set_bt_compare</a>, -<a href="../api_c/db_set_bt_minkey.html">DB->set_bt_minkey</a>, -<a href="../api_c/db_set_bt_prefix.html">DB->set_bt_prefix</a>, -<a href="../api_c/db_set_cachesize.html">DB->set_cachesize</a>, -<a href="../api_c/db_set_dup_compare.html">DB->set_dup_compare</a>, -<a href="../api_c/db_set_errcall.html">DB->set_errcall</a>, -<a href="../api_c/db_set_errfile.html">DB->set_errfile</a>, -<a href="../api_c/db_set_errpfx.html">DB->set_errpfx</a>, -<a href="../api_c/db_set_flags.html">DB->set_flags</a>, -<a href="../api_c/db_set_h_ffactor.html">DB->set_h_ffactor</a>, -<a href="../api_c/db_set_h_hash.html">DB->set_h_hash</a>, -<a href="../api_c/db_set_h_nelem.html">DB->set_h_nelem</a>, -<a href="../api_c/db_set_lorder.html">DB->set_lorder</a>, -<a href="../api_c/db_set_malloc.html">DB->set_malloc</a>, -<a href="../api_c/db_set_pagesize.html">DB->set_pagesize</a>, -<a href="../api_c/db_set_paniccall.html">DB->set_paniccall</a>, -<a href="../api_c/db_set_q_extentsize.html">DB->set_q_extentsize</a>, -<a href="../api_c/db_set_realloc.html">DB->set_realloc</a>, -<a href="../api_c/db_set_re_delim.html">DB->set_re_delim</a>, -<a href="../api_c/db_set_re_len.html">DB->set_re_len</a>, -<a href="../api_c/db_set_re_pad.html">DB->set_re_pad</a>, -<a href="../api_c/db_set_re_source.html">DB->set_re_source</a>, -<a href="../api_c/db_stat.html">DB->stat</a>, -<a href="../api_c/db_sync.html">DB->sync</a>, -<a href="../api_c/db_upgrade.html">DB->upgrade</a> -and -<a href="../api_c/db_verify.html">DB->verify</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> -</td></tr></table> -<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> -</body> -</html> |